FacNavBar Properties

The FacNavBar object contains the following properties:

Property	SubType	Read Only	Description
AllowAllValues	Boolean	No	If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed. Use (1 - Yes) to enable.
AllowBlankValues	Boolean	No	If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified. Use (1 - Yes) to enable.
BackColor	Long	No	BackColor selects a background color for the Facility Navigation BarTool. Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'
BorderStyle	Long	No	BorderStyle specifies the border style of the Facility Navigation Bar windows. Available values are: 1 - None 2 - Fixed single
FacNavBarAttributesDescriptions	String	No	Specifies the user descriptions of Facility Navigation Bar attributes.
FacNavBarAttributesValues	String	No	Specifies the values of Facility Navigation Bar attributes.
Filter
Font	String	No	Specifies the font used by the Facility Navigation Bar. Note: In script, you can set font properties using "-13, Arial" for example.
InitialFilterRules	String	No	Specifies the facility Initial Rule filter.
LabelAttribute	Long	No	Specifies the label attribute for a specified level as an integer. When this property is set, two parameters are required: an integer that specifies the level for the label attribute and a second integer that identifies the label attribute (for example, FacNavBar.X.LabelAttribute 0, 30). When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttribute(0)).
LabelAttributeString	String	No	Specifies the label attribute of a specified level as a string. When this property is set, two parameters are required: an integer that specifies the level for the label attribute, and a string that identifies the label attribute (for example, FacNavBar.X.LabelAttributeString 0, "facility_category"). When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttributeString(0)).
LabelText	String	No	Specifies the label text for a specified level. When this property is set, two parameters are required: an integer that specifies the level for the label text and a string that is the label text (for example, FacNavBar.X.LabelText 0, "Facility Category"). When this property is retrieved, one parameter is required: an integer that specifies the level for the label text being retrieved (for example, MsgBox FacNavBar.X.LabelText(0)).
LabelType	Long	No	Specifies the label type for a specified level. The property can be 1 - Attribute or 2 - Text. When this property is set, two parameters are required: an integer that specifies the level for the label and an integer that specifies the label type (for example, FacNavBar.X.LabelType 0, 1). When this property is retrieved, one parameter is required: an integer that specifies the level for the label type (for example, MsgBox FacNavBar.X.LabelType(0)).
Levels	Long	No	Specifies the total number of drop-down levels in the tool. The default is 3.
RuntimeCfgAutoPersist	Boolean	No	Sets the control's automatic persistence of run-time configuration settings.
RuntimeCfgPersistName	String	No	Specifies the registry persistence name for the run-time configuration.
SelectionsPersistName	String	No	Specifies the registry persistence name for the run-time selections.
ShowDescriptions	Boolean	No	Specifies whether descriptions (rather than table entry names) are shown for table-driven facility attributes. Notes: When this property is set, two parameters are required: an integer that specifies the level for the property and a Boolean value to set (for example, FacNavBar.X.ShowDescriptions 0, True). When this property is retrieved, one parameter is required: an integer that specifies the level for retrieving the property (for example, MsgBox FacNavBar.X.ShowDescriptions(0)).
ShowLabels	Boolean	No	Specifies whether labels appear above the drop-down menus. Default is 1 - Yes.
ShowTargetLevel	Boolean	No	If Levels is selected, the last drop-down menu in the Facility or Group Navigation Bar contains a list of facilities or leaf nodes based on the last level. Otherwise, the last drop-down shows the last level in the hierarchy.
SiteService	String	No	[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service. If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.
TargetLevel	Short	Yes	Returns the number of the target level of the filter hierarchy.
Width	Long	No	Specifies the width of the combo box at the specified filter level. When this property is set, two parameters are required: an integer that specifies the level for the width setting and an integer that represents the width (for example, FacNavBar.X.Width 0, 100). When this property is retrieved, one parameter is required: an integer that identifies the level for the width being retrieved (for example, MsgBox FacNavBar.X.Width(0)).
WidthType	Integer	No	Specifies the width type of a specified level. Options are 1 - Variable or 2 - Fixed. When this property is set, two parameters are required: an integer that specifies the level for the width type and an integer that identifies the width type (for example, FacNavBar.X.WidthType 0, 1). When this property is retrieved, one parameter is required: an integer that specifies the level for the width type being retrieved (for example, MsgBox FacNavBar.X.WidthType(0)).

Property

SubType

Read Only

Description

AllowAllValues

Boolean

If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed.

Use (1 - Yes) to enable.

AllowBlankValues

Boolean

If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified.

Use (1 - Yes) to enable.

BackColor

Long

BackColor selects a background color for the Facility Navigation BarTool.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

BorderStyle

Long

BorderStyle specifies the border style of the Facility Navigation Bar windows. Available values are:

1 - None
2 - Fixed single

FacNavBarAttributesDescriptions

String

Specifies the user descriptions of Facility Navigation Bar attributes.

FacNavBarAttributesValues

String

Specifies the values of Facility Navigation Bar attributes.

Filter

Font

String

Specifies the font used by the Facility Navigation Bar.

Note: In script, you can set font properties using "-13, Arial" for example.

InitialFilterRules

String

Specifies the facility Initial Rule filter.

LabelAttribute

Long

Specifies the label attribute for a specified level as an integer.

When this property is set, two parameters are required: an integer that specifies the level for the label attribute and a second integer that identifies the label attribute (for example, FacNavBar.X.LabelAttribute 0, 30).
When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttribute(0)).

LabelAttributeString

String

Specifies the label attribute of a specified level as a string.

When this property is set, two parameters are required: an integer that specifies the level for the label attribute, and a string that identifies the label attribute (for example, FacNavBar.X.LabelAttributeString 0, "facility_category").
When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttributeString(0)).

LabelText

String

Specifies the label text for a specified level.

When this property is set, two parameters are required: an integer that specifies the level for the label text and a string that is the label text (for example, FacNavBar.X.LabelText 0, "Facility Category").
When this property is retrieved, one parameter is required: an integer that specifies the level for the label text being retrieved (for example, MsgBox FacNavBar.X.LabelText(0)).

LabelType

Long

Specifies the label type for a specified level. The property can be 1 - Attribute or 2 - Text.

When this property is set, two parameters are required: an integer that specifies the level for the label and an integer that specifies the label type (for example, FacNavBar.X.LabelType 0, 1).
When this property is retrieved, one parameter is required: an integer that specifies the level for the label type (for example, MsgBox FacNavBar.X.LabelType(0)).

Levels

Long

Specifies the total number of drop-down levels in the tool. The default is 3.

RuntimeCfgAutoPersist

Boolean

Sets the control's automatic persistence of run-time configuration settings.

RuntimeCfgPersistName

String

Specifies the registry persistence name for the run-time configuration.

SelectionsPersistName

String

Specifies the registry persistence name for the run-time selections.

ShowDescriptions

Boolean

Specifies whether descriptions (rather than table entry names) are shown for table-driven facility attributes.

Notes:

When this property is set, two parameters are required: an integer that specifies the level for the property and a Boolean value to set (for example, FacNavBar.X.ShowDescriptions 0, True).

When this property is retrieved, one parameter is required: an integer that specifies the level for retrieving the property (for example, MsgBox FacNavBar.X.ShowDescriptions(0)).

ShowLabels

Boolean

Specifies whether labels appear above the drop-down menus. Default is 1 - Yes.

ShowTargetLevel

Boolean

If Levels is selected, the last drop-down menu in the Facility or Group Navigation Bar contains a list of facilities or leaf nodes based on the last level. Otherwise, the last drop-down shows the last level in the hierarchy.

SiteService

String

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

TargetLevel

Short

Yes

Returns the number of the target level of the filter hierarchy.

Width

Long

Specifies the width of the combo box at the specified filter level.

When this property is set, two parameters are required: an integer that specifies the level for the width setting and an integer that represents the width (for example, FacNavBar.X.Width 0, 100).
When this property is retrieved, one parameter is required: an integer that identifies the level for the width being retrieved (for example, MsgBox FacNavBar.X.Width(0)).

WidthType

Integer

Specifies the width type of a specified level. Options are 1 - Variable or 2 - Fixed.

When this property is set, two parameters are required: an integer that specifies the level for the width type and an integer that identifies the width type (for example, FacNavBar.X.WidthType 0, 1).
When this property is retrieved, one parameter is required: an integer that specifies the level for the width type being retrieved (for example, MsgBox FacNavBar.X.WidthType(0)).