NavigationPane Class
Represents a pane for a NavigationBar control.
public class NavigationPane : UIContainerControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, IImageListProvider
- Inheritance:
- Object UIContainerControl Object
Constructors
NavigationPane()
Initializes a new instance of the NavigationPane
class.
public NavigationPane()
Remarks
The default constructor initializes all fields to their default values.
NavigationPane(String, String, Image, Image)
Initializes a new instance of the NavigationPane
class.
public NavigationPane(string key, string text, Image largeImage, Image smallImage)
Parameter | Type | Description |
---|---|---|
key | String | A string-based key that identifies an object within its parent collection. |
text | String | The text caption. |
largeImage | Image | The large Image. |
smallImage | Image | The small Image. |
NavigationPane(String, String, Int32)
Initializes a new instance of the NavigationPane
class.
public NavigationPane(string key, string text, int imageIndex)
Parameter | Type | Description |
---|---|---|
key | String | A string-based key that identifies an object within its parent collection. |
text | String | The text caption. |
imageIndex | Int32 | The index of an image within an |
Properties
Active
Gets or sets whether the pane is visible.
public bool Active { get; set; }
Property Value
- Boolean:
true
if the pane is visible; otherwise,false
.
Anchor
Gets or sets which edges of the control are anchored to the edges of its container.
public override AnchorStyles Anchor { get; set; }
Property Value
- AnchorStyles:
A bitwise combination of the AnchorStyles values. The default is
Top
andLeft
.
BackgroundFill
Gets or sets the pane-specific BackgroundFill for the navigation pane.
public BackgroundFill BackgroundFill { get; set; }
Property Value
- BackgroundFill:
The pane-specific BackgroundFill for the navigation pane.
ButtonBackgroundFill
Gets or sets the pane-specific BackgroundFill for a navigation pane button.
public BackgroundFill ButtonBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The pane-specific BackgroundFill for a navigation pane button.
ButtonDisabledForeColor
Gets or sets the pane-specific foreground color of a disabled navigation pane button.
public Color ButtonDisabledForeColor { get; set; }
Property Value
ButtonFont
Gets or sets the pane-specific Font to use when drawing a NavigationPaneButton.
public virtual Font ButtonFont { get; set; }
Property Value
- Font:
The pane-specific Font to use when drawing a NavigationPaneButton.
ButtonForeColor
Gets or sets the pane-specific foreground color of a navigation pane button.
public Color ButtonForeColor { get; set; }
Property Value
ButtonHotBackgroundFill
Gets or sets the pane-specific BackgroundFill for a navigation pane button in a hot state.
public BackgroundFill ButtonHotBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The pane-specific BackgroundFill for a navigation pane button in a hot state.
ButtonHotPressedBackgroundFill
Gets or sets the pane-specific BackgroundFill for a navigation pane button in a hot/pressed state.
public BackgroundFill ButtonHotPressedBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The pane-specific BackgroundFill for a navigation pane button in a hot/pressed state.
ButtonLocation
Gets a NavigationPaneButtonLocation indicating the current location of the pane.
public NavigationPaneButtonLocation ButtonLocation { get; }
Property Value
- NavigationPaneButtonLocation:
A NavigationPaneButtonLocation indicating the current location of the pane.
ButtonPressedBackgroundFill
Gets or sets the pane-specific BackgroundFill for a navigation pane button in a pressed state.
public BackgroundFill ButtonPressedBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The pane-specific BackgroundFill for a navigation pane button in a pressed state.
DefaultActive
Gets or sets the default value for the Active property that is set whenever the Reset button is pressed in the Navigation Bar Options form.
public bool DefaultActive { get; set; }
Property Value
DefaultSortOrder
Gets or sets the default sort order for the pane whenever the Reset button is pressed in the Navigation Bar Options form.
public int DefaultSortOrder { get; set; }
Property Value
- Int32:
A number indicating the default sort order.
Dock
Gets or sets which edge of the parent container a control is docked to.
public override DockStyle Dock { get; set; }
Property Value
ImageIndex
Gets or sets the index of an image within an ImageList
that is displayed on the pane.
[ImageIndex]
public int ImageIndex { get; set; }
Property Value
- Int32:
The index of an image within an
ImageList
that is displayed on the pane. The default value is-1
.
IsSelected
Gets whether the pane is selected.
public bool IsSelected { get; }
Property Value
- Boolean:
true
if the pane is selected; otherwise,false
.
Key
Gets or sets a string-based key that identifies an object within its parent collection.
public string Key { get; set; }
Property Value
- String:
A string-based key that identifies an object within its parent collection.
LargeImage
Gets or sets the large image that is displayed on the pane.
public Image LargeImage { get; set; }
Property Value
- Image:
The large
Image
displayed on the pane. The default value is null.
NavigationBar
Gets the NavigationBar that contains the pane.
public NavigationBar NavigationBar { get; }
Property Value
- NavigationBar:
The NavigationBar that contains the pane.
SmallImage
Gets or sets the small image that is displayed on the pane.
public Image SmallImage { get; set; }
Property Value
- Image:
The small
Image
displayed on the pane. The default value is null.
TabIndex
Gets or sets the tab order of the control within its container.
public int TabIndex { get; set; }
Property Value
- Int32:
The index value of the control within the set of controls within its container that are included in the tab order.
TabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
public bool TabStop { get; set; }
Property Value
- Boolean:
true
if the user can give the focus to the control using the TAB key; otherwise,false
. The default istrue
.
Text
Gets or sets the text caption.
UseControlGraphicsForMeasure
Gets or sets whether to use a call to the control's CreateGraphics
method to obtain the Graphics used for measure routines.
protected override bool UseControlGraphicsForMeasure { get; }
Property Value
- Boolean:
true
if the control'sCreateGraphics
method should be called; otherwise,false
. The default value istrue
.
UseExtendedDoubleBuffering
Gets or sets whether to use extended double buffering for rendering.
protected override bool UseExtendedDoubleBuffering { get; }
Property Value
- Boolean:
true
if extended double buffering should be used; otherwise,false
.
Visible
Gets or sets a value indicating whether the control is displayed.
public bool Visible { get; set; }
Property Value
- Boolean:
true
if the control is displayed; otherwise,false
. The default istrue
.
Methods
CreateControlsInstance()
Creates a new instance of the control collection for the control.
protected override Control.ControlCollection CreateControlsInstance()
Returns
- Control.ControlCollection:
A new instance of a Control.ControlCollection assigned to the control.
GetLargeImage()
Returns the large Image
associated with the pane.
public Image GetLargeImage()
Returns
- Image:
The large
Image
associated with the pane.
Remarks
If an image has been set to the LargeImage property, that will be returned.
Otherwise, the ImageIndex property will be used to find an
image in a parent ImageList
.
GetSmallImage()
Returns the small Image
associated with the pane.
public Image GetSmallImage()
Returns
- Image:
The small
Image
associated with the pane.
Remarks
If an image has been set to the SmallImage property, that will be returned.
Otherwise, the ImageIndex property will be used to find an
image in a parent ImageList
.
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
ResetBackgroundFill()
Resets the BackgroundFill property to its default value.
public virtual void ResetBackgroundFill()
ResetButtonBackgroundFill()
Resets the ButtonBackgroundFill property to its default value.
public virtual void ResetButtonBackgroundFill()
ResetButtonDisabledForeColor()
Resets the ButtonDisabledForeColor property to its default value.
public virtual void ResetButtonDisabledForeColor()
ResetButtonFont()
Resets the ButtonFont property to its default value.
public virtual void ResetButtonFont()
ResetButtonForeColor()
Resets the ButtonForeColor property to its default value.
public virtual void ResetButtonForeColor()
ResetButtonHotBackgroundFill()
Resets the ButtonHotBackgroundFill property to its default value.
public virtual void ResetButtonHotBackgroundFill()
ResetButtonHotPressedBackgroundFill()
Resets the ButtonHotPressedBackgroundFill property to its default value.
public virtual void ResetButtonHotPressedBackgroundFill()
ResetButtonPressedBackgroundFill()
Resets the ButtonPressedBackgroundFill property to its default value.
public virtual void ResetButtonPressedBackgroundFill()
ShouldSerializeBackgroundFill()
Indicates whether the BackgroundFill property should be persisted.
public virtual bool ShouldSerializeBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonBackgroundFill()
Indicates whether the ButtonBackgroundFill property should be persisted.
public virtual bool ShouldSerializeButtonBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonDisabledForeColor()
Indicates whether the ButtonDisabledForeColor property should be persisted.
public virtual bool ShouldSerializeButtonDisabledForeColor()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonFont()
Indicates whether the ButtonFont property should be persisted.
public virtual bool ShouldSerializeButtonFont()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonForeColor()
Indicates whether the ButtonForeColor property should be persisted.
public virtual bool ShouldSerializeButtonForeColor()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonHotBackgroundFill()
Indicates whether the ButtonHotBackgroundFill property should be persisted.
public virtual bool ShouldSerializeButtonHotBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonHotPressedBackgroundFill()
Indicates whether the ButtonHotPressedBackgroundFill property should be persisted.
public virtual bool ShouldSerializeButtonHotPressedBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonPressedBackgroundFill()
Indicates whether the ButtonPressedBackgroundFill property should be persisted.
public virtual bool ShouldSerializeButtonPressedBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
Explicit Interface Implementations
IImageListProvider.GetImageList(Object, Object)
Returns an ImageList
for the specified element and context.
ImageList IImageListProvider.GetImageList(object requestor, object context)
Parameter | Type | Description |
---|---|---|
requestor | Object | The object that is requesting the |
context | Object | An object that provides context information. |
Returns
- ImageList:
The
ImageList
that should be used.
Inherited Members
- UIContainerControl.ILogicalTreeNode.FindAncestor(Type)
- UIContainerControl.ILogicalTreeNode.GetCommonAncestor(ILogicalTreeNode)
- UIContainerControl.ILogicalTreeNode.IsAncestorOf(ILogicalTreeNode)
- UIContainerControl.ILogicalTreeNode.IsDescendantOf(ILogicalTreeNode)
- UIContainerControl.IUIControl.AddPendingGraphicsInversion(Rectangle)
- UIContainerControl.IUIControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIContainerControl.IUIControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIContainerControl.IUIControl.AddToInvalidatedRegion(Rectangle)
- UIContainerControl.IUIElement.GetDrawState()
- UIContainerControl.IUIElement.HitTest(PointHitTestParameters)
- UIContainerControl.IUIElement.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.IUIElement.HitTestRecursive(PointHitTestParameters)
- UIContainerControl.IUIElement.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.IUIElement.NotifyChildDesiredSizeChanged()
- UIContainerControl.IUIElement.NotifyMouseLeaveEvent()
- UIContainerControl.AddPendingGraphicsInversion(Rectangle)
- UIContainerControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIContainerControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIContainerControl.AddToInvalidatedRegion()
- UIContainerControl.AddToInvalidatedRegion(Rectangle)
- UIContainerControl.Arrange(Rectangle)
- UIContainerControl.ArrangeOverride(Size)
- UIContainerControl.ContainsLocation(Point)
- UIContainerControl.CreateChildren()
- UIContainerControl.Dispose(Boolean)
- UIContainerControl.GetCursor(Point)
- UIContainerControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIContainerControl.InvalidateArrange()
- UIContainerControl.InvalidateMeasure()
- UIContainerControl.Measure(Graphics, Size)
- UIContainerControl.MeasureOverride(Graphics, Size)
- UIContainerControl.OnClick(EventArgs)
- UIContainerControl.OnDoubleClick(EventArgs)
- UIContainerControl.OnHandleCreated(EventArgs)
- UIContainerControl.OnLayout(LayoutEventArgs)
- UIContainerControl.OnLocationChanged(EventArgs)
- UIContainerControl.OnMouseDown(MouseEventArgs)
- UIContainerControl.OnMouseEnter(EventArgs)
- UIContainerControl.OnMouseHover(EventArgs)
- UIContainerControl.OnMouseLeave(EventArgs)
- UIContainerControl.OnMouseMove(MouseEventArgs)
- UIContainerControl.OnMouseUp(MouseEventArgs)
- UIContainerControl.OnMouseWheel(MouseEventArgs)
- UIContainerControl.OnPaint(PaintEventArgs)
- UIContainerControl.OnPaintBackground(PaintEventArgs)
- UIContainerControl.OnParentChanged()
- UIContainerControl.OnRenderChildElements(PaintEventArgs)
- UIContainerControl.OnResize(EventArgs)
- UIContainerControl.OnRightToLeftChanged(EventArgs)
- UIContainerControl.OnVisibleChanged(EventArgs)
- UIContainerControl.Render(PaintEventArgs)
- UIContainerControl.ResetDoubleBufferCanvas(Boolean)
- UIContainerControl.ResumePainting()
- UIContainerControl.SuspendPainting()
- UIContainerControl.TransformToAncestor(IUIElement)
- UIContainerControl.TransformToDescendant(IUIElement)
- UIContainerControl.UpdateLayout()
- UIContainerControl.IUIElement.CreateGraphics()
- UIContainerControl.ILogicalTreeNode.Children
- UIContainerControl.ILogicalTreeNode.Parent
- UIContainerControl.IUIControl.MouseCaptureElement
- UIContainerControl.IUIControl.Capture
- UIContainerControl.IUIElement.Bounds
- UIContainerControl.IUIElement.Size
- UIContainerControl.IUIElement.Visibility
- UIContainerControl.IUIElement.VisualOffset
- UIContainerControl.ActualHeight
- UIContainerControl.ActualWidth
- UIContainerControl.BackColor
- UIContainerControl.BackgroundImage
- UIContainerControl.CaptureMouseWhenPressed
- UIContainerControl.ClipBounds
- UIContainerControl.DesiredSize
- UIContainerControl.Font
- UIContainerControl.ForeColor
- UIContainerControl.IsArrangeValid
- UIContainerControl.IsMeasureValid
- UIContainerControl.IsPaintValid
- UIContainerControl.IsRightToLeft
- UIContainerControl.LastMouseUpButton
- UIContainerControl.PaintingSuspended