WinForms

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

    Show / Hide Table of Contents

    Class HTMLFormat

    Implementation of the HTMLFormat interface.

    Inheritance
    System.Object
    HTMLFormat
    Implements
    IHTMLFormat
    System.ICloneable
    System.IDisposable
    System.Runtime.Serialization.ISerializable
    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.HTMLUI
    Assembly: Syncfusion.HTMLUI.Windows.dll
    Syntax
    [AttributeHolder(typeof(HTMLFormat))]
    public class HTMLFormat : IHTMLFormat, ICloneable, IDisposable, ISerializable

    Constructors

    HTMLFormat(SerializationInfo, StreamingContext)

    Initializes a new instance of the HTMLFormat class

    Declaration
    protected HTMLFormat(SerializationInfo info, StreamingContext ctxt)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    Serialization info.

    System.Runtime.Serialization.StreamingContext ctxt

    Serialization context.

    HTMLFormat(String)

    Initializes a new instance of the HTMLFormat class

    Declaration
    public HTMLFormat(string name)
    Parameters
    Type Name Description
    System.String name

    Name of the format.

    HTMLFormat(String, Int64)

    Initializes a new instance of the HTMLFormat class

    Declaration
    public HTMLFormat(string name, long index)
    Parameters
    Type Name Description
    System.String name

    Name of the format.

    System.Int64 index

    Index of the format.

    HTMLFormat(String, Int64, IHTMLFormat)

    Initializes a new instance of the HTMLFormat class

    Declaration
    public HTMLFormat(string name, long index, IHTMLFormat parent)
    Parameters
    Type Name Description
    System.String name

    string name value

    System.Int64 index

    index value

    IHTMLFormat parent

    IHTMLFormat instance

    Properties

    BackgroundColor

    Gets or sets the background color of the format.

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

    BackgroundImage

    Gets or sets the background image of the format.

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

    BackgroundImageRepeat

    Gets or sets the background repeat property of the format.

    Declaration
    public RepeatStyle BackgroundImageRepeat { get; set; }
    Property Value
    Type Description
    RepeatStyle

    Bottom

    Gets or sets the bottom border of the format.

    Declaration
    public IBorder Bottom { get; set; }
    Property Value
    Type Description
    IBorder

    BottomSpace

    Gets the bottom space to the content.

    Declaration
    protected int BottomSpace { get; }
    Property Value
    Type Description
    System.Int32

    Cursor

    Gets or sets the cursor of the format.

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

    DisplayNone

    Gets or sets a value indicating whether 'display' attribute was set to none.

    Declaration
    protected bool DisplayNone { get; set; }
    Property Value
    Type Description
    System.Boolean

    DisposeWithElement

    Gets or sets a value indicating whether the format should be disposed when the parent HTML element is being disposed.

    Declaration
    protected bool DisposeWithElement { get; set; }
    Property Value
    Type Description
    System.Boolean

    Font

    Gets or sets the font of the format.

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

    FontFamilyName

    Gets or sets the family of the font for the current format.

    Declaration
    protected string FontFamilyName { get; set; }
    Property Value
    Type Description
    System.String

    FontSize

    Gets or sets the size of the font for the current format.

    Declaration
    protected float FontSize { get; set; }
    Property Value
    Type Description
    System.Single

    FontStyle

    Gets or sets the FontStyle property of the format.

    Declaration
    protected FontStyle FontStyle { get; set; }
    Property Value
    Type Description
    System.Drawing.FontStyle

    FontWeight

    Gets or sets the FontWeight property of the format.

    Declaration
    protected FontStyle FontWeight { get; set; }
    Property Value
    Type Description
    System.Drawing.FontStyle

    ForeColor

    Gets or sets the foreground color for the format.

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

    FormatParent

    Gets the format from which this format is inherited.

    Declaration
    public IHTMLFormat FormatParent { get; }
    Property Value
    Type Description
    IHTMLFormat

    Height

    Gets or sets the height of the element region.

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

    HeightType

    Gets or sets the type of the height attribute.

    Declaration
    public SizeTypeEx HeightType { get; set; }
    Property Value
    Type Description
    SizeTypeEx

    HorizontalAlign

    Gets or sets the horizontal alignment of the format.

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

    Index

    Gets the index of the format.

    Declaration
    public long Index { get; }
    Property Value
    Type Description
    System.Int64

    IsDisposed

    Gets a value indicating whether the instance is already disposed.

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

    IsFontCreated

    Gets or sets a value indicating whether the font has been created after merging the format.

    Declaration
    protected bool IsFontCreated { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsHeightDefault

    Gets a value indicating whether the height of the format has default values.

    Declaration
    protected bool IsHeightDefault { get; }
    Property Value
    Type Description
    System.Boolean

    IsMerged

    Gets or sets a value indicating whether the format is already merged.

    Declaration
    protected bool IsMerged { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsWidthDefault

    Gets a value indicating whether the width of the format has default values.

    Declaration
    protected bool IsWidthDefault { get; }
    Property Value
    Type Description
    System.Boolean

    Left

    Gets or sets the left border of the format.

    Declaration
    public IBorder Left { get; set; }
    Property Value
    Type Description
    IBorder

    LeftSpace

    Gets the left space to the content.

    Declaration
    protected int LeftSpace { get; }
    Property Value
    Type Description
    System.Int32

    Name

    Gets or sets the name of the format.

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

    Padding

    Gets or sets the paddings for the format.

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

    PaddingBottom

    Gets or sets the bottom padding for the format.

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

    PaddingLeft

    Gets or sets the left padding for the format.

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

    PaddingRight

    Gets or sets the right padding for the format.

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

    PaddingTop

    Gets or sets the top padding for the format.

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

    QuietMode

    Gets or sets a value indicating whether the format is in quiet mode, skip event.

    Declaration
    protected bool QuietMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    Right

    Gets or sets the right border of the format.

    Declaration
    public IBorder Right { get; set; }
    Property Value
    Type Description
    IBorder

    RightSpace

    Gets the right space to the content.

    Declaration
    protected int RightSpace { get; }
    Property Value
    Type Description
    System.Int32

    TextDecoration

    Gets or sets the TextDecoration property of the format.

    Declaration
    protected FontStyle TextDecoration { get; set; }
    Property Value
    Type Description
    System.Drawing.FontStyle

    Top

    Gets or sets the top border of the format.

    Declaration
    public IBorder Top { get; set; }
    Property Value
    Type Description
    IBorder

    TopSpace

    Gets the top space to the content.

    Declaration
    protected int TopSpace { get; }
    Property Value
    Type Description
    System.Int32

    Type

    Gets or sets the manner in which the format is to be connected to the element.

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

    Unit

    Gets or sets the graphical unit for the font size.

    Declaration
    protected GraphicsUnit Unit { get; set; }
    Property Value
    Type Description
    System.Drawing.GraphicsUnit

    VerticalAlign

    Gets or sets the vertical alignment of the format.

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

    Width

    Gets or sets the width of the element region.

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

    WidthType

    Gets or sets the type of the width attribute.

    Declaration
    public SizeTypeEx WidthType { get; set; }
    Property Value
    Type Description
    SizeTypeEx

    Methods

    Clone()

    Clones object.

    Declaration
    public HTMLFormat Clone()
    Returns
    Type Description
    HTMLFormat

    Cloned object.

    Dispose()

    Disposes objects and frees its resources.

    Declaration
    public void Dispose()

    Finalize()

    Finalizes an instance of the HTMLFormat class

    Declaration
    protected void Finalize()

    GetInheritedFormat()

    Returns the format from parent element with inherited and not inherited options.

    Declaration
    public HTMLFormat GetInheritedFormat()
    Returns
    Type Description
    HTMLFormat

    New object with inherited cloned options.

    MergeFormats(ArrayList, HTMLFormat, HTMLFormat)

    Merges formats from an array of possible formats.

    Declaration
    public static HTMLFormat MergeFormats(ArrayList formats, HTMLFormat inputFormat, HTMLFormat default)
    Parameters
    Type Name Description
    System.Collections.ArrayList formats

    Array of formats.

    HTMLFormat inputFormat

    First format object.

    HTMLFormat default

    Default format object.

    Returns
    Type Description
    HTMLFormat

    Format after merging.

    MergeTwoFormats(HTMLFormat, HTMLFormat)

    Merges two formats and returns the final format from them.

    Declaration
    public static HTMLFormat MergeTwoFormats(HTMLFormat oldFormat, HTMLFormat newFormat)
    Parameters
    Type Name Description
    HTMLFormat oldFormat

    First format object.

    HTMLFormat newFormat

    Second format object.

    Returns
    Type Description
    HTMLFormat

    Format after merging.

    OnBackgroundColorChanged(String, ValueChangedEventArgs)

    Method called by BackgroundColor property set part. This is the best place for any logic which must control the BackgroundColor property changes (for inheritors).

    Declaration
    protected virtual void OnBackgroundColorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnBackgroundImageChanged(String, ValueChangedEventArgs)

    Method called by BackgroundImage property set part. This is the best place for any logic which must control the BackgroundImage property changes (for inheritors).

    Declaration
    protected virtual void OnBackgroundImageChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnBackgroundImageRepeatChanged(String, ValueChangedEventArgs)

    Method called by BackgroundImageRepeat property set part. This is the best place for any logic which must control the BackgroundImageRepeat property changes (for inheritors).

    Declaration
    protected virtual void OnBackgroundImageRepeatChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnBottomChanged(String, ValueChangedEventArgs)

    Method called by Bottom property set part. This is the best place for any logic which must control the Bottom property changes (for inheritors).

    Declaration
    protected virtual void OnBottomChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnCursorChanged(String, ValueChangedEventArgs)

    Method called by Cursor property set part. This is the best place for any logic which must control the Cursor property changes (for inheritors).

    Declaration
    protected virtual void OnCursorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnFontChanged(String, ValueChangedEventArgs)

    Method called by Font property set part. This is the best place for any logic which must control the Font property changes (for inheritors).

    Declaration
    protected virtual void OnFontChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnForeColorChanged(String, ValueChangedEventArgs)

    Method called by ForeColor property set part. This is the best place for any logic which must control the ForeColor property changes (for inheritors).

    Declaration
    protected virtual void OnForeColorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnHeightChanged(String, ValueChangedEventArgs)

    Method called by Height property set part. This is thebest place for any logic which must control Height property changes (for inheritors).

    Declaration
    protected virtual void OnHeightChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnHorizontalAlignChanged(String, ValueChangedEventArgs)

    Method called by HorizontalAlign property set part. This is the best place for any logic which must control the HorizontalAlign property changes (for inheritors).

    Declaration
    protected virtual void OnHorizontalAlignChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnLeftChanged(String, ValueChangedEventArgs)

    Method called by Left property set part. This is the best place for any logic which must control the Left property changes (for inheritors).

    Declaration
    protected virtual void OnLeftChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnNameChanged(String, ValueChangedEventArgs)

    Method called by Name property set part. This is the best place for any logic which must control the Name property changes (for inheritors).

    Declaration
    protected virtual void OnNameChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnPaddingChanged(String, ValueChangedEventArgs)

    Method called by Padding property set part. This is the best place for any logic which must control the Padding property changes (for inheritors).

    Declaration
    protected virtual void OnPaddingChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnParentChanged(String, ValueChangedEventArgs)

    Method called by Parent property set part. This is the best place for any logic which must control the Parent property changes (for inheritors).

    Declaration
    protected virtual void OnParentChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnQuietModeChanged()

    Raised when Quiet Mode property is changed.

    Declaration
    protected virtual void OnQuietModeChanged()

    OnRightChanged(String, ValueChangedEventArgs)

    Method called by Right property set part. This is the best place for any logic which must control the Right property changes (for inheritors).

    Declaration
    protected virtual void OnRightChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnTopChanged(String, ValueChangedEventArgs)

    Method called by Top property set part. This is the best place for any logic which must control the Top property changes (for inheritors).

    Declaration
    protected virtual void OnTopChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnVerticalAlignChanged(String, ValueChangedEventArgs)

    Method called by VerticalAlign property set part. This is the best place for any logic which must control the VerticalAlign property changes (for inheritors).

    Declaration
    protected virtual void OnVerticalAlignChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnWidthChanged(String, ValueChangedEventArgs)

    Method called by Width property set part. This is the best place for any logic which must control the Width property changes (for inheritors).

    Declaration
    protected virtual void OnWidthChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    String name value

    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    RaiseBackgroundColorChanged(String, ValueChangedEventArgs)

    Raises BackgroundColorChanged event if BackgroundColor property value is changed.

    Declaration
    protected void RaiseBackgroundColorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseBackgroundImageChanged(String, ValueChangedEventArgs)

    Raises BackgroundImageChanged event if BackgroundImage property value is changed.

    Declaration
    protected void RaiseBackgroundImageChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseBackgroundImageRepeatChanged(String, ValueChangedEventArgs)

    Raises BackgroundImageTypeChanged event if BackgroundImageType property value is changed.

    Declaration
    protected void RaiseBackgroundImageRepeatChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseBottomChanged(String, ValueChangedEventArgs)

    Raises BottomChanged event if Bottom property value is changed.

    Declaration
    protected void RaiseBottomChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseCursorChanged(String, ValueChangedEventArgs)

    Raises CursorChanged event if Cursor property value is changed.

    Declaration
    protected void RaiseCursorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseFontChanged(String, ValueChangedEventArgs)

    Raises FontChanged event if font property value is changed.

    Declaration
    protected void RaiseFontChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseForeColorChanged(String, ValueChangedEventArgs)

    Raises ForeColorChanged event if ForeColor property value is changed.

    Declaration
    protected void RaiseForeColorChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseHeightChanged(String, ValueChangedEventArgs)

    Raises HeightChanged event if Height property value is changed.

    Declaration
    protected void RaiseHeightChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseHorizontalAlignChanged(String, ValueChangedEventArgs)

    Raises HorizontalAlignChanged event if HorizontalAlign property value is changed.

    Declaration
    protected void RaiseHorizontalAlignChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseLeftChanged(String, ValueChangedEventArgs)

    Raises LeftChanged event if Left property value is changed.

    Declaration
    protected void RaiseLeftChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseNameChanged(String, ValueChangedEventArgs)

    Raises NameChanged event if name property value is changed.

    Declaration
    protected void RaiseNameChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseOnChanged(String, ValueChangedEventArgs)

    Raises event if any format property has been changed.

    Declaration
    protected void RaiseOnChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaisePaddingChanged(String, ValueChangedEventArgs)

    Raises PaddingChanged event if Padding property value is changed.

    Declaration
    protected void RaisePaddingChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseParentChanged(String, ValueChangedEventArgs)

    Raises ParentChanged event if parent property value is changed.

    Declaration
    protected void RaiseParentChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseQuietModeChangedEvent()

    Raises event when mode changes.

    Declaration
    protected void RaiseQuietModeChangedEvent()

    RaiseRightChanged(String, ValueChangedEventArgs)

    Raises RightChanged event if Right property value is changed.

    Declaration
    protected void RaiseRightChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseTopChanged(String, ValueChangedEventArgs)

    Raises TopChanged event if Top property value is changed.

    Declaration
    protected void RaiseTopChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseVerticalAlignChanged(String, ValueChangedEventArgs)

    Raises VerticalAlignChanged event if VerticalAlign property value is changed.

    Declaration
    protected void RaiseVerticalAlignChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    RaiseWidthChanged(String, ValueChangedEventArgs)

    Raises WidthChanged event if Width property value is changed.

    Declaration
    protected void RaiseWidthChanged(string name, ValueChangedEventArgs args)
    Parameters
    Type Name Description
    System.String name

    Name of the event.

    ValueChangedEventArgs args

    Event arguments.

    ShouldSerializeBackgroundColor()

    Indicates whether the background color property is serialized.

    Declaration
    protected virtual bool ShouldSerializeBackgroundColor()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeBackgroundImage()

    Serialization helper property. It indicates when the BackgroundImage property must be serialized into code.

    Declaration
    protected virtual bool ShouldSerializeBackgroundImage()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeBottom()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeBottom()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeCursor()

    Serialization helper property. It indicates when the cursor property value must be serialized into code.

    Declaration
    protected virtual bool ShouldSerializeCursor()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeFont()

    Indicates whether the font property is serialized.

    Declaration
    protected virtual bool ShouldSerializeFont()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeForeColor()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeForeColor()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeHeight()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeHeight()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeHorizontalAlign()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeHorizontalAlign()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeLeft()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeLeft()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializePadding()

    Serialization helper property. It indicates when the padding property must be serialized into code.

    Declaration
    protected virtual bool ShouldSerializePadding()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeRight()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeRight()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeTop()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeTop()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeVerticalAlign()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeVerticalAlign()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeWidth()

    Indicates whether the forecolor property is serialized.

    Declaration
    protected virtual bool ShouldSerializeWidth()
    Returns
    Type Description
    System.Boolean

    bool value

    ToString()

    Overridden. Returns the string representation of the object.

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

    String representation of the object.

    Overrides
    System.Object.ToString()

    Events

    BackgroundColorChanged

    Utility event. Raised on Background property change.

    Declaration
    public event ValueChangedEventHandler BackgroundColorChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    BackgroundImageChanged

    Utility event. Raised on Background image property change.

    Declaration
    public event ValueChangedEventHandler BackgroundImageChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    BackgroundImageRepeatChanged

    Utility event. Raised on Background repeat property change.

    Declaration
    public event ValueChangedEventHandler BackgroundImageRepeatChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    BottomChanged

    Utility event. Raised on Bottom property change.

    Declaration
    public event ValueChangedEventHandler BottomChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    CursorChanged

    Utility event. Raised on Cursor property change.

    Declaration
    public event ValueChangedEventHandler CursorChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    FontChanged

    Utility event. Raised on Font property change.

    Declaration
    public event ValueChangedEventHandler FontChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    ForeColorChanged

    Utility event. Raised on ForeColor property change.

    Declaration
    public event ValueChangedEventHandler ForeColorChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    HeightChanged

    Utility event. Raised on Height property change.

    Declaration
    public event ValueChangedEventHandler HeightChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    HorizontalAlignChanged

    Utility event. Raised on HorizontalAlign property change.

    Declaration
    public event ValueChangedEventHandler HorizontalAlignChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    LeftChanged

    Utility event. Raised on Left property change.

    Declaration
    public event ValueChangedEventHandler LeftChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    NameChanged

    Utility event. Raised on Name property change.

    Declaration
    public event ValueChangedEventHandler NameChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    OnChanged

    Utility event. Raised on property change.

    Declaration
    public event BeforeValueChangeEventHandler OnChanged
    Event Type
    Type Description
    BeforeValueChangeEventHandler

    PaddingChanged

    Utility event. Raised on Padding property change.

    Declaration
    public event ValueChangedEventHandler PaddingChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    ParentChanged

    Utility event. Raised on FormatParent property change.

    Declaration
    public event ValueChangedEventHandler ParentChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    QuietModeChanged

    Delegate. Raised when quiet mode property is changed.

    Declaration
    public event EventHandler QuietModeChanged
    Event Type
    Type Description
    System.EventHandler

    RightChanged

    Utility event. Raised on Right property change.

    Declaration
    public event ValueChangedEventHandler RightChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    TopChanged

    Utility event. Raised on Top property change.

    Declaration
    public event ValueChangedEventHandler TopChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    VerticalAlignChanged

    Utility event. Raised on VerticalAlign property change.

    Declaration
    public event ValueChangedEventHandler VerticalAlignChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    WidthChanged

    Utility event. Raised on Width property change.

    Declaration
    public event ValueChangedEventHandler WidthChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    Explicit Interface Implementations

    ICloneable.Clone()

    Clones object.

    Declaration
    object ICloneable.Clone()
    Returns
    Type Description
    System.Object

    Cloned object.

    ISerializable.GetObjectData(SerializationInfo, StreamingContext)

    Serializes object.

    Declaration
    void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    Serialization info.

    System.Runtime.Serialization.StreamingContext context

    Serialization context.

    Implements

    IHTMLFormat
    System.ICloneable
    System.IDisposable
    System.Runtime.Serialization.ISerializable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved