New to Telerik UI for WPFStart a free 30-day trial

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:

C#
public class DocumentList

Inheritance: objectDocumentList

Derived Classes: BulletedListNumberedList

Constructors

C#
public DocumentList(ListStyle style, RadDocument document, int? id, bool shouldCreateNewDocumentListOnInsert)
Parameters:styleListStyledocumentRadDocumentidint?shouldCreateNewDocumentListOnInsertbool
C#
public DocumentList(ListStyle style, RadDocument document, int? id = null)
Parameters:styleListStyledocumentRadDocumentidint?

Properties

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

C#
public ListStyle ActualStyle { get; }

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

C#
public RadDocument Document { get; set; }

Gets the first paragraph of the document list.

C#
public Paragraph FirstParagraph { get; }

Gets the unique identifier of the document list.

C#
public int ID { get; }
Property Value:

The identifier associated with the document list.

Gets the number of paragraphs in the document list.

C#
public int ParagraphCount { get; }
Property Value:

The total count of paragraphs in the document list.

Gets the collection of paragraphs in the document list.

C#
public IEnumerable<Paragraph> Paragraphs { get; }
C#
protected int ParagraphsCount { get; }

Gets or sets the style of the document list.

C#
public ListStyle Style { get; set; }
Property Value:

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

Gets or sets the style identifier for the document list.

C#
public int StyleId { get; }
Property Value:

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

Methods

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

C#
public void AddParagraph(Paragraph paragraph, int listLevel)
Parameters:paragraphParagraph

The paragraph to be added to the document list.

listLevelint

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

Adds a paragraph to the document list.

C#
public void AddParagraph(Paragraph paragraph)
Parameters:paragraphParagraph

The paragraph to be added to the document list.

Changes the left indentation of the document list.

C#
public void ChangeLeftIndent(double indent)
Parameters:indentdouble

The amount of indentation to apply, in points.

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

C#
public void DecreaseLeftIndent()

Retrieves the proper list information for the specified RadDocument.

C#
public static DocumentList GetProperListInfo(RadDocument document)
Parameters:documentRadDocument

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.

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

C#
public void IncreaseLeftIndent()

Removes a specified paragraph from the document list.

C#
public void RemoveParagraph(Paragraph paragraph, bool removingFromOldList = false)
Parameters:paragraphParagraph

The paragraph to be removed from the list.

removingFromOldListbool

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