WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class Bar

    Show / Hide Table of Contents

    Class Bar

    NavigationView's bar.

    Inheritance
    System.Object
    Bar
    Implements
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    IContainBars
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Tools.Navigation
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class Bar : INotifyPropertyChanged, IDisposable, IContainBars

    Constructors

    Bar()

    Initializes a new instance of the Bar class.

    Declaration
    public Bar()

    Bar(String)

    Initializes a new instance of the Bar class and sets its text.

    Declaration
    public Bar(string text)
    Parameters
    Type Name Description
    System.String text

    The Bar's text.

    Properties

    AutoExpand

    Gets or sets a value indicating whether Bar's menu auto expands when mouse is over the bar.

    Declaration
    public bool AutoExpand { get; set; }
    Property Value
    Type Description
    System.Boolean

    Bars

    Gets Collection of child bars.

    Declaration
    public BarCollection Bars { get; }
    Property Value
    Type Description
    BarCollection

    DisabledImage

    Gets or sets disabled Bar's image.

    Declaration
    public Image DisabledImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image
    Remarks

    DisabledImageIndex is ignored if DisabledImage has non-null value.

    DisabledImageIndex

    Gets or sets the disabled Bar's index of the image in ImageList.

    Declaration
    public int DisabledImageIndex { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    is ignored if Image has non-null value.

    Enabled

    Gets or sets a value indicating whether this Bar is enabled.

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    Image

    Gets or sets Bar's image.

    Declaration
    public Image Image { get; set; }
    Property Value
    Type Description
    System.Drawing.Image
    Remarks

    ImageIndex is ignored if Image has non-null value.

    ImageIndex

    Gets or sets the Bar's index of the image in ImageList.

    Declaration
    public int ImageIndex { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    ImageIndex is ignored if Image has non-null value.

    Tag

    Gets or sets the object that contains data about the Bar.

    Declaration
    public object Tag { get; set; }
    Property Value
    Type Description
    System.Object

    An System.Object that contains data about the Bar. The default is null.

    Text

    Gets or sets Bar's text.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    Visible

    Gets or sets a value indicating whether this Bar is visible.

    Declaration
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    VisibleBars

    Gets the collection of visible Bars.

    Declaration
    public BarCollection VisibleBars { get; }
    Property Value
    Type Description
    BarCollection

    Methods

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Declaration
    protected void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Finalize()

    Declaration
    protected void Finalize()

    FirePropertyChangedEvent(Bar.Properties)

    Fires PropertyChanged event.

    Declaration
    protected void FirePropertyChangedEvent(Bar.Properties property)
    Parameters
    Type Name Description
    Bar.Properties property

    Chaned property

    IsSelected(NavigationView)

    Determines whether this instance of Bar is a selected bar of the specified NavigationView.

    Declaration
    public bool IsSelected(NavigationView owner)
    Parameters
    Type Name Description
    NavigationView owner

    The instance of NavigationView owner control.

    Returns
    Type Description
    System.Boolean

    Returns true if selected

    See Also
    SelectedBar

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()

    Events

    PropertyChanged

    Occurs when a property value changes.

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    IContainBars
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved