CxGrpNavBar Properties

Scripting > CxHmiGrp > CxGrpNavBar Object > CxGrpNavBar Properties

CxGrpNavBar Properties

The CxGrpNavBar object contains the following properties:

Property	SubType	Read Only	Description
AutoConfigureLevels	Boolean	No	Specifies whether drop-down levels are auto-configured or manually configured. If auto-configure is set to 1 - Yes: The number of drop-downs is automatically configured based on the levels in the navigation hierarchy. The number of drop-downs must be at least one more than the number of levels in the hierarchy (the first drop-down contains the name of the navigation view; the last drop-down contains the list of facilities if the object’s Show Target property is true). The column widths are set to the column label or the contents of the drop-down, whichever is greater. The sort criterion is set to Facility Description. Filtering is disabled. The default is 1 - Yes. If set to 0 - No, you must manually configure the drop-down menus. For details, see Configuring Drop-Down Levels.
BackColor	OLE_Color	No	Returns/sets the background color.
BorderStyle	Short	No	Returns/sets the border style.
Font	StdFont	No	Returns/sets the font used by the CxGrpNavBar.
GrpNavBarAttributesDescriptions	String	No	Returns/sets the XML specifying the descriptions of custom attributes. For ease of use, this property is configured via the Define Filter Attributes dialog box in the OCX Properties.
GrpNavBarAttributesValues	String	No	Returns/sets the XML specifying the values of custom attributes. For ease of use, this property is configured via the Define Filter Attributes dialog box in the OCX Properties.
LabelAttribute	Long	No	Returns/sets the label attribute as a number.
LabelAttributeSource	ELabelAttributeSource	No	Returns/sets the label attribute source identifier.
LabelAttributeString	String	No	Returns/sets the label attribute for the specified level as a string.
LabelText	String	No	Returns/sets the label text for the specified level.
LabelType	ELabelType	No	Returns/sets the label type option for the specified level.
Levels	Long	No	Returns/sets the hierarchy levels.
PersistName	String	No	Returns/sets the registry persistence key name.
RestrictLeavesToTarget	Boolean	No	Returns/sets whether or not leaf nodes can be targeted if parent nodes are present in a combo box.
RootNodeRules	String	No	Returns/sets the group root node rule identifier XML. For ease of use, this property is configured via the Rules dialog box in the OCX Properties.
Rules	String	No	Returns/sets the rules criteria XML for a specified level. For ease of use, this property is configured via the Filter dialog box in the OCX Properties.
ShowLabels	Boolean	No	Show/hides the hierarchy labels.
ShowTargetLevel	Boolean	No	Shows/hides the target level.
SiteService	String	No	Returns/sets the group service SiteService.
Sort	String	No	Returns/sets the sort criteria for the specified level.
TargetLevel	Short	Yes	Returns the target level.
TargetPosition	ETargetLevelPosition	No	Returns/sets the target position.
Width	Long	No	Returns/sets the fixed width value.
WidthType	EWidthType	No	Returns/sets the fixed width option for the specified level.

See Group Navigation Bar Tool - Properties for more information.