Interface IUOLClientControls

Provides UOL SDK controls, such as dialogs that can be used to interact with the UOL platform.

Namespace: UOL.SDK.Controls

Assembly: UOL.SDK.Controls.dll

Syntax

public interface IUOLClientControls

Methods

Logout()

Logs out the active user.

Declaration

void Logout()

Examples

Call this method to log out the active user:

uolClientControls.Logout();

ShowEtimClassPickerDialog()

Shows the ETIM class picker dialog. Use this dialog to have end-users pick an ETIM and ETIM MC class code.

Declaration

EtimPickerDialogResult ShowEtimClassPickerDialog()

Returns

Type	Description
EtimPickerDialogResult	A EtimPickerDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the EtimPickerDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Search site within a forms application:

var dialogResult = uolClientControls.ShowEtimClassPickerDialog();
var filterResult = dialogResult.CADFilterResult;

ShowEtimClassPickerDialog(String)

Shows the ETIM class picker dialog. Use this dialog to have end-users pick an ETIM and ETIM MC class code.

Declaration

EtimPickerDialogResult ShowEtimClassPickerDialog(string caption)

Parameters

Type	Name	Description
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
EtimPickerDialogResult	A EtimPickerDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the EtimPickerDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Search site within a forms application:

var dialogResult = uolClientControls.ShowEtimClassPickerDialog("Test UOL");
var filterResult = dialogResult.CADFilterResult;

ShowEtimClassPickerDialog(IWin32Window)

Shows the ETIM class picker dialog with the specified owner. Use this dialog to have end-users pick an ETIM and ETIM MC class code.

Declaration

EtimPickerDialogResult ShowEtimClassPickerDialog(IWin32Window owner)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.

Returns

Type	Description
EtimPickerDialogResult	A EtimPickerDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the EtimPickerDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Search site within a forms application:

var dialogResult = uolClientControls.ShowEtimClassPickerDialog(this);
var filterResult = dialogResult.CADFilterResult;

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).

ShowEtimClassPickerDialog(IWin32Window, String)

Shows the ETIM class picker dialog with the specified owner. Use this dialog to have end-users pick an ETIM and ETIM MC class code.

Declaration

EtimPickerDialogResult ShowEtimClassPickerDialog(IWin32Window owner, string caption)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
EtimPickerDialogResult	A EtimPickerDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the EtimPickerDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Search site within a forms application:

var dialogResult = uolClientControls.ShowEtimClassPickerDialog(this, "Test UOL");
var filterResult = dialogResult.CADFilterResult;

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).

ShowLoginDialog()

Shows a Login dialog where end-users can sign-in with their UOL account.

Declaration

LoginDialogResult ShowLoginDialog()

Returns

Type	Description
LoginDialogResult	A LoginDialogResult with the authorization code acquired after the user signed in. Inspect the Cancelled property of the LoginDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Login dialog within a forms application:

var dialogResult = uolClientControls.ShowLoginDialog();
var authorizationCode = dialogResult.AuthorizationCode;

ShowLoginDialog(String)

Shows a Login dialog where end-users can sign-in with their UOL account.

Declaration

LoginDialogResult ShowLoginDialog(string caption)

Parameters

Type	Name	Description
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
LoginDialogResult	A LoginDialogResult with the authorization code acquired after the user signed in. Inspect the Cancelled property of the LoginDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Login dialog within a forms application:

var dialogResult = uolClientControls.ShowLoginDialog("Test Login");
var authorizationCode = dialogResult.AuthorizationCode;

ShowLoginDialog(IWin32Window)

Shows a Login dialog where end-users can sign-in with their UOL account.

Declaration

LoginDialogResult ShowLoginDialog(IWin32Window owner)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.

Returns

Type	Description
LoginDialogResult	A LoginDialogResult with the authorization code acquired after the user signed in. Inspect the Cancelled property of the LoginDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Login dialog within a forms application:

var dialogResult = uolClientControls.ShowLoginDialog(this);
var authorizationCode = dialogResult.AuthorizationCode;

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).

ShowLoginDialog(IWin32Window, String)

Shows a Login dialog where end-users can sign-in with their UOL account.

Declaration

LoginDialogResult ShowLoginDialog(IWin32Window owner, string caption)

Parameters

Type	Name	Description
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
LoginDialogResult	A LoginDialogResult with the authorization code acquired after the user signed in. Inspect the Cancelled property of the LoginDialogResult to see if the user cancelled the dialog.

Examples

Call this method to start the UOL Login dialog within a forms application:

var dialogResult = uolClientControls.ShowLoginDialog(this, "Test Login");
var authorizationCode = dialogResult.AuthorizationCode;

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).

ShowUOLEditDialog(IEnumerable<CADFilterResult>)

Shows the UOL edit dialog. Use this dialog to have end-users edit product data.

Declaration

UOLEditDialogResult ShowUOLEditDialog(IEnumerable<CADFilterResult> filters)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UOL.Models.CADFilterResult>	filters	The filters to use to get the right product.

Returns

Type	Description
UOLEditDialogResult	A UOLEditDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the UOLEditDialogResult to see if the user cancelled the dialog.

ShowUOLEditDialog(IEnumerable<CADFilterResult>, String)

Shows the UOL edit dialog. Use this dialog to have end-users edit product data.

Declaration

UOLEditDialogResult ShowUOLEditDialog(IEnumerable<CADFilterResult> filters, string caption)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UOL.Models.CADFilterResult>	filters	The filters to use to get the right product.
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
UOLEditDialogResult	A UOLEditDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the UOLEditDialogResult to see if the user cancelled the dialog.

Examples

Call this method to open the Edit Dialog of the UOL site:

var dialogResult = uolClientControls.ShowUOLEditDialog(new List<CADFilterResult>() { cadFilterResult }, "Test Edit");
var numberOfProducts = dialogResult.CADFilterResult.CADProducts.Count();

ShowUOLEditDialog(IEnumerable<CADFilterResult>, IWin32Window)

Shows the UOL edit dialog with the specified owner. Use this dialog to have end-users edit product data.

Declaration

UOLEditDialogResult ShowUOLEditDialog(IEnumerable<CADFilterResult> filters, IWin32Window owner)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UOL.Models.CADFilterResult>	filters	The filters to use to get the right product.
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.

Returns

Type	Description
UOLEditDialogResult	A UOLEditDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the UOLEditDialogResult to see if the user cancelled the dialog.

Examples

Call this method to open the Edit Dialog of the UOL site:

var dialogResult = uolClientControls.ShowUOLEditDialog(new List<CADFilterResult>() { cadFilterResult }, this);
var numberOfProducts = dialogResult.CADFilterResult.CADProducts.Count();

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).

ShowUOLEditDialog(IEnumerable<CADFilterResult>, IWin32Window, String)

Shows the UOL edit dialog with the specified owner. Use this dialog to have end-users edit product data.

Declaration

UOLEditDialogResult ShowUOLEditDialog(IEnumerable<CADFilterResult> filters, IWin32Window owner, string caption)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UOL.Models.CADFilterResult>	filters	The filters to use to get the right product.
System.Windows.Forms.IWin32Window	owner	Any object that implements System.Windows.Forms.IWin32Window that represents the top-level window that will own the modal dialog box.
System.String	caption	A string providing the caption for the dialog.

Returns

Type	Description
UOLEditDialogResult	A UOLEditDialogResult with the ETIM and ETIM MC class codes that the end-user selected. Inspect the Cancelled property of the UOLEditDialogResult to see if the user cancelled the dialog.

Examples

Call this method to open the Edit Dialog of the UOL site:

var dialogResult = uolClientControls.ShowUOLEditDialog(new List<CADFilterResult>() { cadFilterResult }, this, "Test Edit");
var numberOfProducts = dialogResult.CADFilterResult.CADProducts.Count();

Exceptions

Type	Condition
System.ArgumentException	The form specified in the owner parameter is the same as the form being shown.
System.InvalidOperationException	The form being shown is already visible.-or- The form being shown is disabled.-or- The form being shown is not a top-level window.-or- The form being shown as a dialog box is already a modal form.-or-The current process is not running in user interactive mode (for more information, see System.Windows.Forms.SystemInformation.UserInteractive).