Show / Hide Table of Contents

# Class List

##### Inheritance

object
ContentElement
ContentNode
List

##### Inherited Members

ContentNode.GetContentNodeIterator()
ContentElement.m_ref
ContentElement.AsContentNode()
ContentElement.AsTextRun()
ContentElement.AsParagraph()
ContentElement.AsTableCell()
ContentElement.AsTableRow()
ContentElement.AsTable()
ContentElement.AsList()
ContentElement.AsListItem()
ContentElement.GetTextStyledElement()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.Layout

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class List : ContentNode

### Constructors

#### List(IntPtr, object)

##### Declaration

    public List(IntPtr impl, object reference)

##### Parameters

Type | Name | Description
--- | --- | ---
IntPtr | impl |
object | reference |

### Fields

#### m_impl

##### Declaration

    protected IntPtr m_impl

##### Field Value

Type | Description
--- | ---
IntPtr |

### Methods

#### AddItem()

Adds a new list item to the list.

##### Declaration

    public ListItem AddItem()

##### Returns

Type | Description
--- | ---
ListItem | The list item object representing the newly added item.

#### ContinueList()

Continues the logical continuation of a particular list, even if other non-list content items have been created since the last call to AddItem(). This method is useful when splitting a sublist and wanting to continue the new items as part of the original sublist hierarchy.

##### Declaration

    public void ContinueList()

#### GetIndentationLevel()

Gets the indentation level of the list.

##### Declaration

    public int GetIndentationLevel()

##### Returns

Type | Description
--- | ---
int | The indentation level of the list.

#### GetLabelStyle()

Gets the text styled element for the list item labels.

##### Declaration

    public TextStyledElement GetLabelStyle()

##### Returns

Type | Description
--- | ---
TextStyledElement | The text styled element representing the label style.

#### GetListIdentifier()

Gets the identifier of the list.

##### Declaration

    public int GetListIdentifier()

##### Returns

Type | Description
--- | ---
int | The identifier of the list.

#### SetNumberFormat(NumberFormat)

Sets the number format of the list.

##### Declaration

    public void SetNumberFormat(List.NumberFormat format)

##### Parameters

Type | Name | Description
--- | --- | ---
List.NumberFormat | format | The number format to set for the list.

#### SetNumberFormat(NumberFormat, string, bool)

Sets the number format of the list with a custom suffix and cascade flag.

##### Declaration

    public void SetNumberFormat(List.NumberFormat format, string suffix, bool cascade)

##### Parameters

Type | Name | Description
--- | --- | ---
List.NumberFormat | format | The number format to set for the list.
string | suffix | The suffix to append to the list item number.
bool | cascade | If true, the number format will be applied to nested lists as well.

#### SetStartIndex(int)

Sets the start index for the list items.

##### Declaration

    public void SetStartIndex(int index)

##### Parameters

Type | Name | Description
--- | --- | ---
int | index | The start index value.