A control system address element Chooser. More...

Inheritance diagram for AcopChooser:

Classes
class	LinkContextConverter

class	LinkDeviceConverter

class	LinkPropertyConverter

class	LinkProtocolConverter

class	LinkServerConverter

class	LinkSubSystemConverter

Public Member Functions
int	GetContextdIndex ()
	Gets the list index of the current context setting More...

String []	GetContextList ()
	Gets the a list of the available contexts More...

int	GetDeviceIndex ()
	Gets the list index of the current device setting More...

String []	GetDeviceList ()
	Gets the a list of the available devices More...

int	GetPropertyIndex ()
	Gets the list index of the current property setting More...

String []	GetPropertyList ()
	Gets the a list of the available properties More...

int	GetServerIndex ()
	Gets the list index of the current server setting More...

String []	GetServerList ()
	Gets the a list of the available servers More...

void	SetContextHighlighted (Boolean[] values)
	Supply highlighted information via an array of boolean values More...

void	SetDeviceHighlighted (Boolean[] values)
	Supply highlighted information via an array of boolean values More...

void	SetPropertyHighlighted (Boolean[] values)
	Supply highlighted information via an array of boolean values More...

void	SetServerHighlighted (Boolean[] values)
	Supply highlighted information via an array of boolean values More...

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used. More...

Properties
Boolean	ApplyContext `[get, set]`
	true: apply the chosen context to targets More...

Boolean	ApplyDevice `[get, set]`
	true: apply the chosen device to targets More...

ApplyEventSettingType	ApplyEventOrder `[get, set]`
	Determines the firing order of a user-defined addressUpdate delegate More...

Boolean	ApplyProperty `[get, set]`
	true: apply the chosen property to targets More...

Boolean	ApplyServer `[get, set]`
	true: apply the chosen server to targets More...

ApplyToEditorValue	ApplyTo `[get, set]`
	Target Component Chooser Editor More...

ApplyWhenEnum	ApplyWhen `[get, set]`
	Besides the Apply button, a selection can be applied if a single address combo box is visible, or via context menu More...

Boolean	ChooseContexts `[get, set]`
	display and allow context browsing in the address chooser More...

Boolean	ChooseDevices `[get, set]`
	display and allow device browsing in the address chooser More...

Boolean	ChooseProperties `[get, set]`
	display and allow property browsing in the address chooser More...

ComboBoxStyle	ChooserStyle `[get, set]`
	Provides the combo box dropdown style More...

Boolean	ChooseServer `[get, set]`
	display and allow server browsing in the address chooser More...

String	Description `[get, set]`
	Optional label for the address chooser More...

String	FilterContexts `[get, set]`
	Provides a filter string (regular expression) to use for filtering combo box items More...

String	FilterDevices `[get, set]`
	Provides a filter string (regular expression) to use for filtering combo box items More...

String	FilterProperties `[get, set]`
	Provides a filter string (regular expression) to use for filtering combo box items More...

String	FilterServer `[get, set]`
	Provides a filter string (regular expression) to use for filtering combo box items More...

Color	HighlightBackColor `[get, set]`
	Highlighted Backcolor of items in a chooser combo box More...

String	HighlightFilter `[get, set]`
	Provides a filter string (regular expression) to use for highlighting combo box items More...

Color	HighlightForeColor `[get, set]`
	Highlighted Forecolor of items in a chooser combo box More...

Color	ItemBackColor `[get, set]`
	Backcolor of items in a chooser combo box More...

Color	ItemForeColor `[get, set]`
	Forecolor of items in a chooser combo box More...

String	LinkAddress `[get, set]`
	Identifies the transport link target. The target end point is given by the LinkAddress and the LinkProperty. More...

String	LinkContext `[get, set]`
	The design-time browseable link context (part of the link address) More...

String	LinkDevice `[get, set]`
	The design-time browseable/editable link device (part of the link address) More...

String	LinkProperty `[get, set]`
	The design-time browseable/editable link property (suppliments the link address)" More...

String	LinkProtocol `[get, set]`
	The link control system protocol More...

String	LinkServer `[get, set]`
	The design-time browseable link server (part of the link address) More...

String	LinkSubSystem `[get, set]`
	The design-time browseable link subsystem More...

Boolean	ShowHeader `[get, set]`
	Show description and apply button or not More...

Events
addressUpdate	acopAddressUpdate
	Occurs when the chosen address is to be applied More...

Detailed Description

A control system address element Chooser.

The chosen address can be assigned to any other ACOP component within the application.

Member Function Documentation

◆ Dispose()

override void Dispose ( bool disposing )

inlineprotected

Clean up any resources being used.

Parameters

disposing true if managed resources should be disposed; otherwise, false.

◆ GetContextdIndex()

int GetContextdIndex ( )

inline

Gets the list index of the current context setting

Returns: the list index of the current context setting

◆ GetContextList()

String [] GetContextList ( )

inline

Gets the a list of the available contexts

Returns: a list of the available contexts

◆ GetDeviceIndex()

int GetDeviceIndex ( )

inline

Gets the list index of the current device setting

Returns: the list index of the current device setting

◆ GetDeviceList()

String [] GetDeviceList ( )

inline

Gets the a list of the available devices

Returns: a list of the available devices

◆ GetPropertyIndex()

int GetPropertyIndex ( )

inline

Gets the list index of the current property setting

Returns: the list index of the current property setting

◆ GetPropertyList()

String [] GetPropertyList ( )

inline

Gets the a list of the available properties

Returns: a list of the available properties

◆ GetServerIndex()

int GetServerIndex ( )

inline

Gets the list index of the current server setting

Returns: the list index of the current server setting

◆ GetServerList()

String [] GetServerList ( )

inline

Gets the a list of the available servers

Returns: a list of the available servers

◆ SetContextHighlighted()

void SetContextHighlighted ( Boolean [] values )

inline

Supply highlighted information via an array of boolean values

Parameters

values An array containing whether a context item is to be highlighted or not

◆ SetDeviceHighlighted()

void SetDeviceHighlighted ( Boolean [] values )

inline

Supply highlighted information via an array of boolean values

Parameters

values An array containing whether a device item is to be highlighted or not

◆ SetPropertyHighlighted()

void SetPropertyHighlighted ( Boolean [] values )

inline

Supply highlighted information via an array of boolean values

Parameters

values An array containing whether a property item is to be highlighted or not

◆ SetServerHighlighted()

void SetServerHighlighted ( Boolean [] values )

inline

Supply highlighted information via an array of boolean values

Parameters

values An array containing whether a server item is to be highlighted or not

Property Documentation

◆ ApplyContext

Boolean ApplyContext

getset

true: apply the chosen context to targets

◆ ApplyDevice

Boolean ApplyDevice

getset

true: apply the chosen device to targets

◆ ApplyEventOrder

ApplyEventSettingType ApplyEventOrder

getset

Determines the firing order of a user-defined addressUpdate delegate

◆ ApplyProperty

Boolean ApplyProperty

getset

true: apply the chosen property to targets

◆ ApplyServer

Boolean ApplyServer

getset

true: apply the chosen server to targets

◆ ApplyTo

ApplyToEditorValue ApplyTo

getset

Target Component Chooser Editor

◆ ApplyWhen

ApplyWhenEnum ApplyWhen

getset

Besides the Apply button, a selection can be applied if a single address combo box is visible, or via context menu

◆ ChooseContexts

Boolean ChooseContexts

getset

display and allow context browsing in the address chooser

◆ ChooseDevices

Boolean ChooseDevices

getset

display and allow device browsing in the address chooser

◆ ChooseProperties

Boolean ChooseProperties

getset

display and allow property browsing in the address chooser

◆ ChooserStyle

ComboBoxStyle ChooserStyle

getset

Provides the combo box dropdown style

◆ ChooseServer

Boolean ChooseServer

getset

display and allow server browsing in the address chooser

◆ Description

String Description

getset

Optional label for the address chooser

◆ FilterContexts

String FilterContexts

getset

Provides a filter string (regular expression) to use for filtering combo box items

◆ FilterDevices

String FilterDevices

getset

Provides a filter string (regular expression) to use for filtering combo box items

◆ FilterProperties

String FilterProperties

getset

Provides a filter string (regular expression) to use for filtering combo box items

◆ FilterServer

String FilterServer

getset

Provides a filter string (regular expression) to use for filtering combo box items

◆ HighlightBackColor

Color HighlightBackColor

getset

Highlighted Backcolor of items in a chooser combo box

◆ HighlightFilter

String HighlightFilter

getset

Provides a filter string (regular expression) to use for highlighting combo box items

◆ HighlightForeColor

Color HighlightForeColor

getset

Highlighted Forecolor of items in a chooser combo box

◆ ItemBackColor

Color ItemBackColor

getset

Backcolor of items in a chooser combo box

◆ ItemForeColor

Color ItemForeColor

getset

Forecolor of items in a chooser combo box

◆ LinkAddress

String LinkAddress

getset

Identifies the transport link target. The target end point is given by the LinkAddress and the LinkProperty.

◆ LinkContext

String LinkContext

getset

The design-time browseable link context (part of the link address)

◆ LinkDevice

String LinkDevice

getset

The design-time browseable/editable link device (part of the link address)

◆ LinkProperty

String LinkProperty

getset

The design-time browseable/editable link property (suppliments the link address)"

◆ LinkProtocol

String LinkProtocol

getset

The link control system protocol

◆ LinkServer

String LinkServer

getset

The design-time browseable link server (part of the link address)

◆ LinkSubSystem

String LinkSubSystem

getset

The design-time browseable link subsystem

◆ ShowHeader

Boolean ShowHeader

getset

Show description and apply button or not

Event Documentation

◆ acopAddressUpdate

addressUpdate acopAddressUpdate

Occurs when the chosen address is to be applied

The documentation for this class was generated from the following files:

AcopChooser.cs
AcopChooser.Designer.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ Dispose()

◆ GetContextdIndex()

◆ GetContextList()

◆ GetDeviceIndex()

◆ GetDeviceList()

◆ GetPropertyIndex()

◆ GetPropertyList()

◆ GetServerIndex()

◆ GetServerList()

◆ SetContextHighlighted()

◆ SetDeviceHighlighted()

◆ SetPropertyHighlighted()

◆ SetServerHighlighted()

Property Documentation

◆ ApplyContext

◆ ApplyDevice

◆ ApplyEventOrder

◆ ApplyProperty

◆ ApplyServer

◆ ApplyTo

◆ ApplyWhen

◆ ChooseContexts

◆ ChooseDevices

◆ ChooseProperties

◆ ChooserStyle

◆ ChooseServer

◆ Description

◆ FilterContexts

◆ FilterDevices

◆ FilterProperties

◆ FilterServer

◆ HighlightBackColor

◆ HighlightFilter

◆ HighlightForeColor

◆ ItemBackColor

◆ ItemForeColor

◆ LinkAddress

◆ LinkContext

◆ LinkDevice

◆ LinkProperty

◆ LinkProtocol

◆ LinkServer

◆ LinkSubSystem

◆ ShowHeader

Event Documentation

◆ acopAddressUpdate