WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ProgressBarCellStyleInfo - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ProgressBarCellStyleInfo

    Represents a class that contains the properties for customizing the styles of the Progress bar.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    StyleInfoBase
    StyleInfoSubObjectBase
    ProgressBarCellStyleInfo
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Inherited Members
    StyleInfoSubObjectBase.Dispose(Boolean)
    StyleInfoSubObjectBase.OnStyleChanged(StyleInfoProperty)
    StyleInfoSubObjectBase.IntGetDefaultStyleInfo(StyleInfoProperty)
    StyleInfoSubObjectBase.MakeCopy(StyleInfoBase, StyleInfoProperty)
    StyleInfoSubObjectBase.SubObjectIdentity
    StyleInfoSubObjectBase.Sip
    StyleInfoSubObjectBase.Data
    StyleInfoSubObjectBase.Owner
    StyleInfoBase.WriteXml(XmlWriter)
    StyleInfoBase.ReadXml(XmlReader)
    StyleInfoBase.SetStore(StyleInfoStore)
    StyleInfoBase.ClearCache()
    StyleInfoBase.Dispose()
    StyleInfoBase.Equals(Object)
    StyleInfoBase.EqualsObject(Object, Object)
    StyleInfoBase.GetHashCode()
    StyleInfoBase.ToString()
    StyleInfoBase.ToString(String)
    StyleInfoBase.ToString(String, IFormatProvider)
    StyleInfoBase.ParseString(String)
    StyleInfoBase.BeginInit()
    StyleInfoBase.EndInit()
    StyleInfoBase.BeginUpdate()
    StyleInfoBase.EndUpdate()
    StyleInfoBase.GetDefaultStyleInfoStore(StyleInfoProperty)
    StyleInfoBase.OnStyleChanging(StyleInfoProperty)
    StyleInfoBase.IsSubset(IStyleInfo)
    StyleInfoBase.CopyFrom(IStyleInfo)
    StyleInfoBase.ModifyStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.InheritStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.MergeStyle(IStyleInfo)
    StyleInfoBase.HasValue(StyleInfoProperty)
    StyleInfoBase.IsValueModified(StyleInfoProperty)
    StyleInfoBase.ResetValue(StyleInfoProperty)
    StyleInfoBase.GetValue(StyleInfoProperty)
    StyleInfoBase.GetDefaultValue(StyleInfoProperty)
    StyleInfoBase.GetShortValue(StyleInfoProperty)
    StyleInfoBase.SetValue(StyleInfoProperty, Object)
    StyleInfoBase.SetValue(StyleInfoProperty, Int16)
    StyleInfoBase.IConvertible.ToUInt64(IFormatProvider)
    StyleInfoBase.IConvertible.ToSByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToDouble(IFormatProvider)
    StyleInfoBase.IConvertible.ToDateTime(IFormatProvider)
    StyleInfoBase.IConvertible.ToSingle(IFormatProvider)
    StyleInfoBase.IConvertible.ToBoolean(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToString(IFormatProvider)
    StyleInfoBase.IConvertible.ToByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToChar(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt64(IFormatProvider)
    StyleInfoBase.IConvertible.GetTypeCode()
    StyleInfoBase.IConvertible.ToDecimal(IFormatProvider)
    StyleInfoBase.IConvertible.ToType(Type, IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt32(IFormatProvider)
    StyleInfoBase.Identity
    StyleInfoBase.CacheValues
    StyleInfoBase.WeakReferenceChangedListeners
    StyleInfoBase.Updating
    StyleInfoBase.IsEmpty
    StyleInfoBase.IsChanged
    StyleInfoBase.Changed
    StyleInfoBase.Changing
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.WinForms.DataGrid.Styles
    Assembly: Syncfusion.SfDataGrid.WinForms.dll
    Syntax
    public class ProgressBarCellStyleInfo : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

    Constructors

    ProgressBarCellStyleInfo()

    Initializes a new instance of the ProgressBarCellStyleInfo class.

    Declaration
    public ProgressBarCellStyleInfo()

    ProgressBarCellStyleInfo(StyleInfoSubObjectIdentity)

    Initializes a new instance of the ProgressBarCellStyleInfo class.

    Declaration
    public ProgressBarCellStyleInfo(StyleInfoSubObjectIdentity identity)
    Parameters
    Type Name Description
    StyleInfoSubObjectIdentity identity

    StyleInfoIdentityBase.

    ProgressBarCellStyleInfo(StyleInfoSubObjectIdentity, ProgressBarCellStyleInfoStore)

    Initializes a new instance of the ProgressBarCellStyleInfo class.

    Declaration
    public ProgressBarCellStyleInfo(StyleInfoSubObjectIdentity identity, ProgressBarCellStyleInfoStore store)
    Parameters
    Type Name Description
    StyleInfoSubObjectIdentity identity

    StyleInfoIdentityBase.

    ProgressBarCellStyleInfoStore store

    The ProgressBarCellStyleInfo.

    ProgressBarCellStyleInfo(ProgressBarCellStyleInfo)

    Initializes a new instance of the ProgressBarCellStyleInfo class.

    Declaration
    public ProgressBarCellStyleInfo(ProgressBarCellStyleInfo style)
    Parameters
    Type Name Description
    ProgressBarCellStyleInfo style

    The ProgressBarCellStyleInfo that need to be initialized.

    ProgressBarCellStyleInfo(ProgressBarCellStyleInfoStore)

    Initializes a new instance of the ProgressBarCellStyleInfo class.

    Declaration
    public ProgressBarCellStyleInfo(ProgressBarCellStyleInfoStore store)
    Parameters
    Type Name Description
    ProgressBarCellStyleInfoStore store

    The ProgressBarCellStyleInfoStore.

    Properties

    AllowBackgroundSegments

    Gets or sets a value indicating whether to enable the progressbar background segments.

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

    AllowForegroundSegments

    Gets or sets a value indicating whether to enable the progressbar foreground segments.

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

    BackgroundColor

    Gets or sets the color to specifies the color used to draw the Background. This applies only when BackGroundStyle is None or AllowSegments is enabled.

    Declaration
    public Color BackgroundColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    BackgroundImage

    Gets or sets the image used to draw the background.

    Declaration
    public Bitmap BackgroundImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Bitmap

    BackgroundStyle

    Gets or sets the style of the background.

    Declaration
    public GridProgressBarStyle BackgroundStyle { get; set; }
    Property Value
    Type Description
    GridProgressBarStyle

    Default

    Gets the default ProgressBarCellStyleInfo.

    Declaration
    public static ProgressBarCellStyleInfo Default { get; }
    Property Value
    Type Description
    ProgressBarCellStyleInfo

    FitGradientColorsToProgressBar

    Gets or sets a value indicating whether multiple gradient colors will be fit based on progress value.

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

    FitImageToProgressBar

    Gets or sets a value indicating whether the foreground image will be fit to progress value.

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

    Font

    Gets or sets the font for drawing text.

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

    ForegroundColor

    Gets or sets the color to specifies the color used to draw the foreground. This applies only when ForeGroundStyle is None or AllowSegments is enabled.

    Declaration
    public Color ForegroundColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ForegroundImage

    Gets or sets the image used to draw the foreground.

    Declaration
    public Bitmap ForegroundImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Bitmap

    ForegroundStyle

    Gets or sets the style of the foreground.

    Declaration
    public GridProgressBarStyle ForegroundStyle { get; set; }
    Property Value
    Type Description
    GridProgressBarStyle

    GradientBackgroundEndColor

    Gets or sets the color to specifies the end color of the background gradient. The BackGroundStyle property should be set to 'Gradient'.

    Declaration
    public Color GradientBackgroundEndColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    GradientBackgroundStartColor

    Gets or sets the color to specifies the start color of the background gradient. The BackGroundStyle property should be set to 'Gradient'.

    Declaration
    public Color GradientBackgroundStartColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    GradientForegroundEndColor

    Gets or sets the end color of the foreground gradient. The ForeGroundStyle property should be set to 'Gradient'.

    Declaration
    public Color GradientForegroundEndColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    GradientForegroundStartColor

    Gets or sets the start color of the foreground gradient. The ForeGroundStyle property should be set to 'Gradient'.

    Declaration
    public Color GradientForegroundStartColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    MultipleGradientBackgroundColors

    Gets or sets the array of colors used to draw the multiple gradient of the background. The BackGoundStyle property should be set to 'MultipleGradient'.

    Declaration
    public List<Color> MultipleGradientBackgroundColors { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Drawing.Color>

    MultipleGradientForegroundColors

    Gets or sets the array of colors used to draw the multiple gradient of the foreground. The ProgressStyle property should be set to 'MultipleGradient’.

    Declaration
    public List<Color> MultipleGradientForegroundColors { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Drawing.Color>

    Orientation

    Gets or sets to determines the horizontal or vertical style of the progress bar.

    Declaration
    public Orientation Orientation { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Orientation

    ProgressTextColor

    Gets or sets the color to specifies the color of the font used to draw the text of the ProgressBar.

    Declaration
    public Color ProgressTextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SegmentWidth

    Gets or sets the value to indicates the width of the segments.

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

    Store

    Gets the ProgressBarCellStyleInfoStore object that holds all the data for this style object.

    Declaration
    public ProgressBarCellStyleInfoStore Store { get; }
    Property Value
    Type Description
    ProgressBarCellStyleInfoStore

    TextAlignment

    Gets or sets the text on the progress bar can be set to left, center, and right.

    Declaration
    public TextAlignment TextAlignment { get; set; }
    Property Value
    Type Description
    TextAlignment

    TextColor

    Gets or sets the color to specifies the color of the font used to draw the text of the ProgressBar.

    Declaration
    public Color TextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    TubeBackgroundEndColor

    Gets or sets the color to specifies the end color of the background tube. The BackGroundStyle property should be set to 'Tube'.

    Declaration
    public Color TubeBackgroundEndColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    TubeBackgroundStartColor

    Gets or sets the color to specifies the start color of the background tube. The BackGroundStyle property should be set to 'Tube'.

    Declaration
    public Color TubeBackgroundStartColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    TubeForegroundEndColor

    Gets or sets the color to specifies the end color of the foreground tube. The ForeGroundStyle property should be set to ‘Tube’.

    Declaration
    public Color TubeForegroundEndColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    TubeForegroundStartColor

    Gets or sets the color to specifies the start color of the foreground tube. The ForeGroundStyle property should be set to ‘Tube’.

    Declaration
    public Color TubeForegroundStartColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    Methods

    CreateSubObjectIdentity(StyleInfoProperty)

    Overridden to create a product-specific identity object for the sub object.

    Declaration
    public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
    Parameters
    Type Name Description
    StyleInfoProperty sip

    StyleInfoProperty descriptor for this sub object.

    Returns
    Type Description
    StyleInfoSubObjectIdentity

    Identity for the sub object.

    Overrides
    StyleInfoBase.CreateSubObjectIdentity(StyleInfoProperty)

    GetDefaultStyle()

    Returns Default.

    Declaration
    protected override StyleInfoBase GetDefaultStyle()
    Returns
    Type Description
    StyleInfoBase

    A ProgressBarCellStyleInfo object with default values.

    Overrides
    StyleInfoBase.GetDefaultStyle()

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    IStyleInfoSubObject
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved