[]
        
(Showing Draft Content)

C1.Win.C1Command.C1NavBar

C1NavBar Class

Represents an Outlook-style navigation bar control.

Namespace: C1.Win.C1Command
Assembly: C1.Win.C1Command.4.8.dll
Syntax
[ToolboxBitmap(typeof(C1NavBar), "C1NavBar.png")]
[C1Description("C1NavBar", "Outlook-style navigation bar control.")]
public class C1NavBar : ContainerControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, ISupportInitialize

Constructors

Name Description
C1NavBar()

Initializes a new instance of the C1NavBar class.

Properties

Name Description
AllowCollapse

Gets or sets a value indicating whether the collapse button is visible.

BackColor

Gets or sets the background color for the control.

ButtonArrangement

Gets or sets the string defining the order and visibility for buttons in this navigation bar.

Buttons

Gets the collection of buttons in this navigation bar.

CloseButton

Gets or sets a value indicating whether the close button is shown in panel caption, and what is closed when it is clicked.

CollapseDirection

Gets or sets a value indicating the direction in which to collapse the control.

Collapsed

Gets or set the value indicating whether the control is currently in a collapsed state.

DefaultArrangement

Gets the string with the default order and visibility options for the buttons.

DefaultButtonIndex

Gets or sets the index of the button to be selected when the form opens.

DefaultSize
DisplayRectangle
ImageIndent

Gets or sets the space before the image on a stack button.

ImageScalingSize

Gets or sets the size of images displayed on stack buttons (24 x 24 pixels by default).

MaxStackButtons

Gets or sets the maximum number of buttons in the stack (unlimited if -1).

Panels

Gets the collection of panels in this navigation bar.

SelectedButton

Gets or sets the button, which is currently selected in the C1NavBar.

SelectedButtonIndex

Gets or sets index of the selected button in the Buttons collection.

SelectedPanel

Gets the currently visible panel in this navigation bar.

ShowOptionsMenu

Gets or sets a value indicating whether the runtime options menu is visible.

ShowVerticalTextOnCollapse

Gets or sets a value indicating whether the vertical text is displayed in collapsed C1NavBar control.

StackButtonCount

Gets or sets the number of buttons displayed in the stack (-1 shows all buttons).

StripHeight

Gets or sets the height of the button strip at the bottom of the navigation bar.

Style

Gets the style of C1NavBar.

TextImageGap

Gets or sets the space between the image and the text on a stack button.

UIStrings

Gets the array of user interface strings.

VisibleButtonCount

Returns the number of visible buttons in the C1NavBar.

VisualStyle

Gets or sets the visual style of the control.

Methods

Name Description
BeginInit()
CreateControlsInstance()
Dispose(bool)
EndInit()
GetCollapsedSize()

Get the value of size for control in a collapsed state.

IC1GetAmbientRootSource(string)

Get active holder of current VisualStyle.

OnAllowCollapseChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._allowCollapseChangedEvent event.

OnBackColorChanged(EventArgs)
OnButtonClick(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._buttonClickEvent event.

OnCloseButtonChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._closeButtonChangedEvent event.

OnCloseButtonClick(CancelEventArgs)

Raises the C1.Win.C1Command.C1NavBar._closeButtonClickEvent event.

OnCollapseButtonClick(CancelEventArgs)

Raises the C1.Win.C1Command.C1NavBar._collapseButtonClickEvent event.

OnCollapseDirectionChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._collapseDirectionChangedEvent event.

OnDoubleClick(EventArgs)
OnForeColorChanged(EventArgs)
OnMouseClick(MouseEventArgs)
OnMouseDown(MouseEventArgs)
OnMouseLeave(EventArgs)
OnMouseMove(MouseEventArgs)
OnMouseUp(MouseEventArgs)
OnPaint(PaintEventArgs)
OnPanelClosed(PanelEventArgs)

Raises the C1.Win.C1Command.C1NavBar._panelClosedEvent event.

OnPanelClosing(PanelCancelEventArgs)

Raises the C1.Win.C1Command.C1NavBar._panelClosingEvent event.

OnPanelHeaderClick(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._panelHeaderClick event.

OnPanelHeaderDoubleClick(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._panelHeaderDoubleClick event.

OnPanelHeaderImageClick(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._panelHeaderImageClick event.

OnParentChanged(EventArgs)
OnResize(EventArgs)
OnRightToLeftChanged(EventArgs)
OnSelectedPanelChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._selectedPanelChangedEvent event.

OnSelectedPanelChanging(NavBarCancelEventArgs)

Raises the SelectedPanelChanging event.

OnShowOptionsMenuChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._showOptionsMenuChangedEvent event.

OnStyleChanged(EventArgs)
OnTextChanged(EventArgs)
OnVisibleChanged(EventArgs)
OnVisualStyleChanged(EventArgs)

Raises the C1.Win.C1Command.C1NavBar._visualStyleChangedEvent event.

ResetBackColor()

This method is for internal use only.

ResetButtonFont()

Restore the C1.Win.C1Command.C1NavBar.ButtonFont property to its default value.

ResetPanelHeaderFont()

Restore the C1.Win.C1Command.C1NavBar.PanelHeaderFont property to its default value.

ResetPanelHeaderImageTransparentColor()

Restore the C1.Win.C1Command.C1NavBar.PanelHeaderImageTransparentColor property to its default value.

ResetSectionHeaderFont()

Restore the C1.Win.C1Command.C1NavBar.SectionHeaderFont property to its default value.

ResetStyle()

Resets the Style property to its default value.

ResetUIStrings()

This method is for internal use only.

ResetVisualStyle()

Restore the VisualStyle property to its default value.

SaveDefaultArrangement()

Save current order and visibility options as the default button arrangement.

ScaleControl(SizeF, BoundsSpecified)
ShouldSerializeBackColor()

This method is for internal use only.

ShouldSerializeButtonFont()

Indicates whether the C1.Win.C1Command.C1NavBar.ButtonFont has a default value.

ShouldSerializePanelHeaderFont()

Indicates whether the C1.Win.C1Command.C1NavBar.PanelHeaderFont has a default value.

ShouldSerializePanelHeaderImageTransparentColor()

Indicates whether the C1.Win.C1Command.C1NavBar.PanelHeaderImageTransparentColor has a default value.

ShouldSerializeSectionHeaderFont()

Indicates whether the C1.Win.C1Command.C1NavBar.SectionHeaderFont has a default value.

ShouldSerializeStyle()

Indicates whether the Style has a default value.

ShouldSerializeUIStrings()

This method is for internal use only.

ShouldSerializeVisualStyle()

Indicates whether the VisualStyle has a default value.

ShouldSerializeVisualStyleBase()

Indicates whether the C1.Win.C1Command.C1NavBar.VisualStyleBase has a default value.

WndProc(ref Message)

Events

Name Description
AllowCollapseChanged

Occurs when the AllowCollapse property is changed.

ButtonClick

Occurs when the user presses the button on the C1NavBar.

CloseButtonChanged

Occurs when the CloseButton property is changed.

CloseButtonClick

Occurs when the close button on the panel header is clicked.

CollapseButtonClick

Occurs when the collapse button on the panel header is clicked. Allows to cancel collapsing.

CollapseDirectionChanged

Occurs when the CollapseDirection property is changed.

PanelClosed

Occurs after a panel has closed.

PanelClosing

Occurs when the currently selected panel is about to be closed by the user. Allows to cancel closing the panel.

PanelHeaderClick

Occurs when the panel header is clicked.

PanelHeaderDoubleClick

Occurs when the panel header is double clicked.

PanelHeaderImageClick

Occurs when the panel header image is clicked.

SelectedPanelChanged

Occurs when the selected panel is changed.

SelectedPanelChanging

Occurs when the currently selected panel is about to be changed. Allows to cancel changing the panel.

ShowOptionsMenuChanged

Occurs when the ShowOptionsMenu property is changed.

VisualStyleChanged

Occurs when the VisualStyle property has changed.