ComponentOne WebMenus and WebBars for ASP.NET (2.0) Search HelpCentral 

Properties in the C1WebCommandEditor – C1WebMenu

You have complete control to quickly customize your C1WebMenu by using the C1WebCommandEditor.

C1WebMenu Properties

When the C1WebMenu object is selected in the tree view of the C1WebCommandEditor, it contains the following types of properties:

·      C1WebMenu Accessibility and Appearance properties

The properties specify the C1WebMenu's accessibility and appearance. The C1WebMenu1's properties and their description are listed below:

Property

Description

AccessKey

Keyboard short-cut used by the control.

TabIndex

The tab order of the element. The tab order is the order that the focus is moved when the Tab key is pressed.

BackColor

Color of the background of the control.

BackImageUrl

Gets or sets the URL of the background image.

BorderColor

Color of the border around the control.

BorderStyle

Style of the border around the control.

BorderWidth

Width of the border around the control.

CallbackWaitControlID

Identifies a control that should be shown during callback to provide visual feedback.

CallbackWaitImageUrl

Url of an image that should be shown during callback to provide visual feedback.

CssClass

CSS class name applied to the control.

Font

The font used for the text within the control.

ForeColor

Color of the text within the control.

GroupPadding

Sets or returns the width of the icon bar drawn on the side of the groups.

IconBarWidth

Default padding for the link items.

ItemPadding

Default spacing between items in a group.

ItemSpacing

Default spacing between items in a group.

Layout

Indicates whether to layout the Web menu items vertically or horizontally.

Padding

Space between the control's border and its inner content.

SubMenuIconBarWidth

Sets or returns the width of the icon bar drawn on the side of the submenus.

SubMenuMark

Indicates whether submenu marks are displayed.

·      C1WebMenu Behavior properties

The properties specify the C1WebMenu's behavior. The C1WebMenu1's behavior properties and their description are listed below:

Property

Description

AllowMultipleSelect

If false, only a single item can be selected in the group.

AllowSelectItem

If true, one or more items in the group can be selected.

AllowUnselectItem

If true, the user can unselect the item by the second click on it.

AlwaysHasSelected

If true and if AllowSelectItem = true at minimum one item in a group is selected.

AutoPostBack

Sets or retrieves a value that indicates whether or not the control posts back to the server each time a user interacts with the control.

CausesValidation

Whether to trigger ASP.NET page validation when a node is selected.

ClickToOpen

If true, the user should click on the root menu for submenus to make the submenus appear.

ClientDir

Points to the directory which contains the client script.

ContextControlId

Client – side ID of the element that the context menu is bounded to.

ContextMenu

Get or sets a context menu and which type of context menu used.

Enabled

Enabled state of the control.

EnableTheming

Indicates whether the control can be themed.

EnableViewState

Whether the control automatically saves its state for use in round-trips.

HorzPopupDirection

Gets or sets the horizontal direction of the submenu's appearance.

PreloadImages

Specifies whether to preload images used in a TabStrip control.

SkinID

The SkinId of the control skin that provides the skin of the control.

Target

Default target (frame or window) to use when navigating.

Tooltip

The ToolTip displayed when the mouse is over the control.

VertPopupDirection

Gets or sets the vertical direction of the submenu's appearance.

Visible

Indicates whether the control is visible and rendered.

 

·      C1WebMenu Data, Layout, and Misc properties

The properties specify the C1WebMenu's data, layout, and Misc properties. The C1WebMenu1's data, layout, and Misc properties and their description are listed below:

Property

Description

Expressions

Gets or sets the data-binding expressions that are bound to properties of this control.

DataBindings

Gets or sets the menu item binding objects that define the relationship between a data item and the menu item it is binding to.

DataSourceID

The control ID of an IdataSource that will be used as the data source.

Height

The height of the control.

Width

The width of the control.

ID

Programmatic name of the control.

·      C1WebMenu Style properties

The properties specify the C1WebMenu's Style properties. The C1WebMenu's Style properties and their description are listed below:

Property

Description

DisabledGroupStyle

Default style for the disabled groups.

DisabledItemStyle

Default style for the child items in the disabled state.

GroupStyle

Default style for the groups.

ItemStyle

Default style for the child items in the normal state.

MouseOverItemStyle

Default style for the child items when the mouse hovers over it.

MouseOverSelectedItemStyle

Default style for the child items when the mouse hovers the selected item.

ScrollAreaStyle

Default style for the scrollable area in the groups.

SelectedItemStyle

Default style for the child items in the selected state.

SeparatorStyle

Default style for the separators.

SpecialSymbolStyle

Default style for special symbols in the menu.

SubmenuDisabledItemStyle

Default style for submenu items in disabled state.

SubmenuItemStyle

Default style for submenu items in normal state.

SubmenuMouseOverItemStyle

Default style for submenu items in mouse over state.

SubmenuMouseOverSelectedItemStyle

Default style for submenu items in mouse over selected state.

SubmenuSelectedItemStyle

Default style for submenu items in selected state.

SubmenuSeparatorStyle

Default style for submenu separators.

SubmenuStyle

Default style for nested submenus.

 

C1WebSubMenu Properties

When C1WebSubMenu  is selected in the tree view of the C1WebCommandEditor, it contains the following types of properties:

·      C1WebSubMenu Accessibility and Appearance properties

The properties specify the C1WebMenu's accessibility and appearance. The C1WebMenu1's properties and their description are listed below:

Property

Description

GroupPadding

Default space between the group's border and items in the group.

IconBarWidth

Sets or returns the width of the icon bar drawn on the side of the groups.

ItemPadding

Gets or sets default space between the item's border and content.

ItemSpacing

Gets or sets the space between the items in the group.

Opacity

Opacity-only for IE5+. Uses DirectX filter. Default is 100 (Opaque).

ShadowColor

Shadow color – only for IE5+. Uses DirectX filter.

ShadowDirection

Shadow direction – only for IE5+. Uses DirectX filter.

WrapText

Gets or sets a value that indicates whether the item's text is wrapped.

 

·      C1WebSubMenu Behavior properties

The properties specify the C1WebSubMenu's behavior. The C1WebSubMenu1's behavior properties and their description are listed below:

Property

Description

AllowMultipleSelect

If false, only a single item can be selected in the group.

AllowMultipleSelectInControl

If false, only a single item can be selected in all of the groups in the control.

AllowSelectItem

If true, one or more items in the group can be selected.

AllowUnselectItem

If true, the user can unselect the item by the second click on it.

AlwaysHasSelected

If true and if AllowSelectItem = true at minimum one item in a group is selected.

Enabled

Gets or sets a value indicating whether the group is enabled.

EnableExpandCollapse

Gets or sets a value indicating whether the user can expand or collapse the group by double-clicking on the header or clicking on the indicator image.

OffsetPixelX

Offset by X axis for the submenu relative to the parent item.

OffsetPixelY

Offset by Y axis for the submenu relative to the parent item.

Tooltip

Gets or sets the ToolTip text displayed when the mouse pointer rests over the group.

Visible

Gets or sets a value indicating whether or not the group is visible.

 

·      C1WebSubMenu Style properties

The properties specify the C1WebSubMenu's Style properties. The C1WebSubMenu's Style properties and their description are listed below:

Property

Description

DisabledGroupStyle

Default style for the disabled group.

DisabledItemStyle

Default style for the child items in the disabled state.

GroupStyle

Style for the group.

ItemStyle

Style for the child items in the normal state.

MouseOverItemStyle

Style for the child items when the mouse hovers over it.

MouseOverSelectedItemStyle

Style for the child items when the mouse hovers the selected item.

SelectedItemStyle

Style for the child items in the selected state.

SeparatorStyle

Default style for the separators.

SpecialSymbolStyle

Default style for special symbols in the submenu.

 

C1WebLinkItem Properties

When a link item is selected in the tree view of the C1WebCommandEditor, it contains the following types of properties:

·      C1WebLinkItem Appearance properties

The properties specify the link item of C1WebMenu's accessibility and appearance. The link items properties and their description are listed below:

Property

Description

IconBarWidth

Sets or returns the width of the icon bar drawn on the side of the groups.

ItemPadding

Space between the item's border and content.

MarkType

Gets or sets the mark type for the menu item.

NavigateUrl

Gets or sets the URL to link to when the hyperlink is clicked in the menu item.

Text

Gets or sets the text displayed for the item in a control.

Tooltip

Gets or sets the ToolTip text displayed when the mouse pointer rests over the item.

 

·      C1WebLinkItem Behavior properties

The properties specify the C1WebMenu link items' behavior. The C1WebMenu link items' behavior properties and their description are listed below:

Property

Description

CausesValidation

Determines whether validation is performed when the item is clicked.

ClientScripts

Collection of client-side scripts associated with the item.

CommandArgument

Gets or sets an optional parameter passed to the ItemClick and ItemSelected events of the component along with the associated CommandName.

CommandName

Gets or sets the command name associated with the Item passed to the ItemClick and ItemSelected events of the component.

Enabled

Gets or sets a value indicating whether the item is enabled.

Selected

Gets or sets a value indicating whether the current item is selected.

Target

Gets or sets the target window or frame to display the Web page content linked when the C1WebLinkItem is clicked.

Visible

Gets or sets a value indicating whether or not the item is visible.

WrapText

Gets or sets a value that indicates whether the text of the item is wrapped.

KeyboardShortcut

String representing keyboard shortcut to perform action on this item.

·      C1WebLinkItem Style properties

The properties specify the C1WebMenu link items' Style properties. The C1WebMenu link items' Style properties and their description are listed below:

Property

Description

DisabledItemStyle

Style for the item in the disabled state.

ItemStyle

Style for the item in the normal state.

MouseOverItemStyle

Style for the item when the mouse hovers over it.

MouseOverSelectedItemStyle

Style for the item when the mouse hovers over the selected item.

SelectedItemStyle

Style for the item in the selected state.

SpecialSymbolStyle

Style for special symbols for the item.

 

C1WebSeparator Properties

When a Seperator item is selected in the tree view of the C1WebCommandEditor, it contains the following types of properties:

·      C1WebSeparator Style properties

The properties specify the C1WebMenu Separator items' Style properties. The Separator items' properties and their description are listed below:

Property

Description

BackColor

Background color of the controls applied with this style.

BackImageSize

Height for horizontal or width for vertical separators.

BackImageUrl

Image url for the separator image.

BorderColor

Border color of the controls applied with this style.

BorderStyle

Style of the border of controls applies with this style.

BorderWidth

Thickness of the border around the controls applied with this style.

CssClass

CSS class name applied to the user of this style.

PaddingBottom

Bottom padding for the separator image.

PaddingLeft

Left padding for the separator image.

PaddingRight

Right padding for the separator image.

PaddingTop

Top padding for the separator image.

 

C1WebContentItem Properties

When a content item is selected in the tree view of the C1WebCommandEditor, it contains the following types of properties:

·      C1WebContentItem Appearance properties

The properties specify the C1WebMenu Content Items' appearance. The content items properties and their description are listed below:

Property

Description

ItemPadding

Space between the item's border and content.

 

·      C1WebContentItem Style properties

The properties specify the C1WebMenu link items' behavior. The C1WebMenu link items' behavior properties and their description are listed below:

Property

Description

BackColor

Background color of the controls applied with this style.

BackImageUrl

The URL of the background image.

BorderColor

Border color of the controls applied with this style.

BorderStyle

Style of the border of controls applied with this style.

BorderWidth

Thickness of the border around the controls applied with this style.

CssClass

CSS class name applied to the user of this style.

Font

The font used for text in controls applied with this style.

ForeColor

Foreground color of the controls applied with this style.

Height

The height of the controls applied with this style.

ImageTextSpacing

Specifies the spacing between the item's image and text.

ImageUrl

The URL of the image to use in an icon place.

ItemImagePosition

Specifies the position of an image relative to the item's text.

LeftBorderImageUrl

The URL of the left border image.

RightBorderImageUrl

The URL of the right border image.

Width

The width of the controls applied with this style.

 

 


Send comments about this topic to ComponentOne.
Copyright © ComponentOne LLC. All rights reserved.