menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WListFormat - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class WListFormat

    Represents the list formatting options.

    Inheritance
    System.Object
    OwnerHolder
    XDLSSerializableBase
    FormatBase
    WListFormat
    Implements
    IXDLSSerializable
    Inherited Members
    FormatBase.EnsureComposites()
    FormatBase.EnsureComposites(Int32[])
    FormatBase.GetBaseKey(Int32)
    FormatBase.GetDefComposite(Int32)
    FormatBase.GetDefComposite(Int32, FormatBase)
    FormatBase.GetFullKey(Int32)
    FormatBase.HasBoolKey(Int32)
    FormatBase.HasKey(Int32)
    FormatBase.ImportContainer(FormatBase)
    FormatBase.ImportMembers(FormatBase)
    FormatBase.Item[Int32]
    FormatBase.m_oldPropertiesHash
    FormatBase.m_propertiesHash
    FormatBase.OnChange(FormatBase, Int32)
    OwnerHolder.Document
    OwnerHolder.m_doc
    XDLSSerializableBase.CloneImpl()
    XDLSSerializableBase.InitXDLSHolder()
    XDLSSerializableBase.IXDLSSerializable.ReadXmlAttributes(IXDLSAttributeReader)
    XDLSSerializableBase.IXDLSSerializable.ReadXmlContent(IXDLSContentReader)
    XDLSSerializableBase.IXDLSSerializable.RestoreReference(String, Int32)
    XDLSSerializableBase.IXDLSSerializable.WriteXmlAttributes(IXDLSAttributeWriter)
    XDLSSerializableBase.IXDLSSerializable.WriteXmlContent(IXDLSContentWriter)
    XDLSSerializableBase.IXDLSSerializable.XDLSHolder
    XDLSSerializableBase.ReadXmlContent(IXDLSContentReader)
    XDLSSerializableBase.RestoreReference(String, Int32)
    XDLSSerializableBase.WriteXmlContent(IXDLSContentWriter)
    XDLSSerializableBase.XDLSHolder
    Namespace: Syncfusion.DocIO.DLS
    Assembly: Syncfusion.DocIO.UWP.dll
    Syntax
    public class WListFormat : FormatBase, IXDLSSerializable

    Constructors

    WListFormat(IWParagraph)

    Initializes a new instance of the WListFormat class with the specified IWParagraph instance.

    Declaration
    public WListFormat(IWParagraph owner)
    Parameters
    Type Name Description
    IWParagraph owner

    The owner entity of the current list format.

    WListFormat(WordDocument, WParagraphStyle)

    Initializes a new instance of the WListFormat class with the specified WordDocument instance along with paragraph style.

    Declaration
    public WListFormat(WordDocument doc, WParagraphStyle owner)
    Parameters
    Type Name Description
    WordDocument doc

    WordDocument instance.

    WParagraphStyle owner

    The owner paragraph style for the current list format.

    Properties

    CurrentListLevel

    Gets the current custom list level.

    Declaration
    public WListLevel CurrentListLevel { get; }
    Property Value
    Type
    WListLevel

    CurrentListStyle

    Gets current custom list style. Read-only.

    Declaration
    public ListStyle CurrentListStyle { get; }
    Property Value
    Type
    ListStyle

    CustomStyleName

    Gets the name of custom style. Read-only.

    Declaration
    public string CustomStyleName { get; }
    Property Value
    Type
    System.String

    ListLevelNumber

    Gets or sets current list nesting level.

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

    List level must be less 8 and greater then 0

    ListType

    Gets type of the list format. Read-only.

    Declaration
    public ListType ListType { get; }
    Property Value
    Type
    ListType

    RestartNumbering

    Gets or sets a value indicating whether numbering of the list must restart from previous list.

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

    True, if the list number must restart from previous list; otherwise, false.

    Methods

    ApplyDefBulletStyle()

    Apply default bullet style for current list's owner paragraph.

    Declaration
    public void ApplyDefBulletStyle()

    ApplyDefNumberedStyle()

    Apply default numbered style for current list's owner paragraph.

    Declaration
    public void ApplyDefNumberedStyle()

    ApplyStyle(String)

    Applies the specified style.

    Declaration
    public void ApplyStyle(string styleName)
    Parameters
    Type Name Description
    System.String styleName

    A String that represents the name of the style to apply.

    ClearFormatting()

    To Clears the list format applied

    Declaration
    public override void ClearFormatting()
    Overrides
    FormatBase.ClearFormatting()

    ContinueListNumbering()

    Continues the list numbering from the previous list.

    Declaration
    public void ContinueListNumbering()

    DecreaseIndentLevel()

    Decrease the current level indent.

    Declaration
    public void DecreaseIndentLevel()
    Remarks

    List level must be less 8 and greater then 0

    GetDefValue(Int32)

    Returns the default values.

    Declaration
    protected override object GetDefValue(int key)
    Parameters
    Type Name Description
    System.Int32 key

    The integer that specifies the key.

    Returns
    Type Description
    System.Object

    An object that specifies the default value.

    Overrides
    FormatBase.GetDefValue(Int32)

    IncreaseIndentLevel()

    Increase the current level indent.

    Declaration
    public void IncreaseIndentLevel()
    Remarks

    List level must be less 8 and greater then 0

    ReadXmlAttributes(IXDLSAttributeReader)

    Reads object data from xml attributes.

    Declaration
    protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
    Parameters
    Type Name Description
    IXDLSAttributeReader reader

    The IXDLSAttributeReader object.

    Overrides
    XDLSSerializableBase.ReadXmlAttributes(IXDLSAttributeReader)

    RemoveList()

    Removes the list from current paragraph.

    Declaration
    public void RemoveList()

    WriteXmlAttributes(IXDLSAttributeWriter)

    Writes object data as xml attributes.

    Declaration
    protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
    Parameters
    Type Name Description
    IXDLSAttributeWriter writer

    The IXDLSAttributeWriter object.

    Overrides
    XDLSSerializableBase.WriteXmlAttributes(IXDLSAttributeWriter)

    Implements

    IXDLSSerializable

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved