Class
DocumentList

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

Definition

Namespace:Telerik.Windows.Documents.Lists

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class DocumentList

Inheritance: objectDocumentList

Derived Classes: BulletedListNumberedList

Constructors

DocumentList(ListStyle, RadDocument, int?)

Declaration

cs-api-definition
public DocumentList(ListStyle style, RadDocument document, int? id = null)

Parameters

style

ListStyle

document

RadDocument

id

int?

DocumentList(ListStyle, RadDocument, int?, bool)

Declaration

cs-api-definition
public DocumentList(ListStyle style, RadDocument document, int? id, bool shouldCreateNewDocumentListOnInsert)

Parameters

style

ListStyle

document

RadDocument

id

int?

shouldCreateNewDocumentListOnInsert

bool

Properties

ActualStyle

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

Declaration

cs-api-definition
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

cs-api-definition
public RadDocument Document { get; set; }

Property Value

RadDocument

FirstParagraph

Gets the first paragraph of the document list.

Declaration

cs-api-definition
public Paragraph FirstParagraph { get; }

Property Value

Paragraph

ID

Gets the unique identifier of the document list.

Declaration

cs-api-definition
public int ID { get; }

Property Value

int

The identifier associated with the document list.

ParagraphCount

Gets the number of paragraphs in the document list.

Declaration

cs-api-definition
public int ParagraphCount { get; }

Property Value

int

The total count of paragraphs in the document list.

Paragraphs

Gets the collection of paragraphs in the document list.

Declaration

cs-api-definition
public IEnumerable<Paragraph> Paragraphs { get; }

Property Value

IEnumerable<Paragraph>

ParagraphsCount

Declaration

cs-api-definition
protected int ParagraphsCount { get; }

Property Value

int

Style

Gets or sets the style of the document list.

Declaration

cs-api-definition
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

cs-api-definition
public int StyleId { get; }

Property Value

int

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

cs-api-definition
public void AddParagraph(Paragraph paragraph)

Parameters

paragraph

Paragraph

The paragraph to be added to the document list.

AddParagraph(Paragraph, int)

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

Declaration

cs-api-definition
public void AddParagraph(Paragraph paragraph, int listLevel)

Parameters

paragraph

Paragraph

The paragraph to be added to the document list.

listLevel

int

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

ChangeLeftIndent(double)

Changes the left indentation of the document list.

Declaration

cs-api-definition
public void ChangeLeftIndent(double indent)

Parameters

indent

double

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

cs-api-definition
public void DecreaseLeftIndent()

GetProperListInfo(RadDocument)

Retrieves the proper list information for the specified RadDocument.

Declaration

cs-api-definition
public static DocumentList GetProperListInfo(RadDocument document)

Parameters

document

RadDocument

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

cs-api-definition
public void IncreaseLeftIndent()

RemoveParagraph(Paragraph, bool)

Removes a specified paragraph from the document list.

Declaration

cs-api-definition
public void RemoveParagraph(Paragraph paragraph, bool removingFromOldList = false)

Parameters

paragraph

Paragraph

The paragraph to be removed from the list.

removingFromOldList

bool

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