Class DocumentList

Represents a document list for formatting and managing structured lists within a Telerik application.

Inheritance
System.Object
DocumentList
BulletedList
NumberedList
Namespace: Telerik.Windows.Documents.Lists
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class DocumentList : Object

Constructors

DocumentList(ListStyle, RadDocument, Nullable<Int32>)

Declaration
public DocumentList(ListStyle style, RadDocument document, Nullable<int> id = null)
Parameters
ListStyle style

RadDocument document

System.Nullable<System.Int32> id

DocumentList(ListStyle, RadDocument, Nullable<Int32>, Boolean)

Declaration
public DocumentList(ListStyle style, RadDocument document, Nullable<int> id, bool shouldCreateNewDocumentListOnInsert)
Parameters
ListStyle style

RadDocument document

System.Nullable<System.Int32> id

System.Boolean shouldCreateNewDocumentListOnInsert

Properties

ActualStyle

Gets the actual style applied to the document list, including any overrides or default styles.

Declaration
public ListStyle ActualStyle { get; }
Property Value
ListStyle

Document

Represents a document list within the Telerik UI for WPF. This class provides functionality for managing and manipulating document lists.

Declaration
public RadDocument Document { get; set; }
Property Value
RadDocument

FirstParagraph

Gets the first paragraph of the document list.

Declaration
public Paragraph FirstParagraph { get; }
Property Value
Paragraph

ID

Gets the unique identifier of the document list.

Declaration
public int ID { get; }
Property Value
System.Int32

The identifier associated with the document list.

ParagraphCount

Gets the number of paragraphs in the document list.

Declaration
public int ParagraphCount { get; }
Property Value
System.Int32

The total count of paragraphs in the document list.

Paragraphs

Gets the collection of paragraphs in the document list.

Declaration
public IEnumerable<Paragraph> Paragraphs { get; }
Property Value
System.Collections.Generic.IEnumerable<Paragraph>

ParagraphsCount

Declaration
protected int ParagraphsCount { get; }
Property Value
System.Int32

Style

Gets or sets the style of the document list.

Declaration
public ListStyle Style { get; set; }
Property Value
ListStyle

The style of the document list, which defines the visual appearance and formatting of the list elements.

StyleId

Gets or sets the style identifier for the document list.

Declaration
public int StyleId { get; }
Property Value
System.Int32

The style identifier associated with the document list, which defines the appearance and formatting of the list.

Methods

AddParagraph(Paragraph)

Adds a paragraph to the document list.

Declaration
public void AddParagraph(Paragraph paragraph)
Parameters
Paragraph paragraph

The paragraph to be added to the document list.

AddParagraph(Paragraph, Int32)

Adds a paragraph to the document list at the specified index.

Declaration
public void AddParagraph(Paragraph paragraph, int listLevel)
Parameters
Paragraph paragraph

The paragraph to be added to the document list.
System.Int32 listLevel

The list level index at which the paragraph should be inserted.

ChangeLeftIndent(Double)

Changes the left indentation of the document list.

Declaration
public void ChangeLeftIndent(double indent)
Parameters
System.Double indent

The amount of indentation to apply, in points.

DecreaseLeftIndent()

Decreases the left indentation of the document list, moving it closer to the left margin.

Declaration
public void DecreaseLeftIndent()

GetProperListInfo(RadDocument)

Retrieves the proper list information for the specified RadDocument.

Declaration
public static DocumentList GetProperListInfo(RadDocument document)
Parameters
RadDocument document

The RadDocument for which to retrieve the list information.
Returns
DocumentList

Returns an object of type ListInfo containing the relevant information about the list in the document.

IncreaseLeftIndent()

Increases the left indentation of the document list by a specified amount.

Declaration
public void IncreaseLeftIndent()

RemoveParagraph(Paragraph, Boolean)

Removes a specified paragraph from the document list.

Declaration
public void RemoveParagraph(Paragraph paragraph, bool removingFromOldList = false)
Parameters
Paragraph paragraph

The paragraph to be removed from the list.
System.Boolean removingFromOldList

A boolean value indicating whether to ensure the paragraph is in the list

Extension Methods