API Reference

Struct

ListInfo

Namespace OfficeIMO.Word.DocumentTraversal
Assembly OfficeIMO.Word
Base ValueType
Modifiers sealed

Describes list information for a paragraph.

Inheritance

  • ValueType
  • ListInfo

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public ListInfo(Int32 level, Boolean ordered, Int32 start, Nullable<NumberFormatValues> format, String text, Nullable<Int32> leftIndentTwips = null, Nullable<Int32> hangingIndentTwips = null, String markerFontFamily = null, Nullable<Boolean> markerBold = null, Nullable<Boolean> markerItalic = null, String markerColorHex = null, Nullable<LevelJustificationValues> levelJustification = null, Nullable<LevelSuffixValues> levelSuffix = null) #

Initializes a new instance of the ListInfo struct.

Parameters

level System.Int32 requiredposition: 0
Zero-based numbering level.
ordered System.Boolean requiredposition: 1
true if the list uses numbering; otherwise, false.
start System.Int32 requiredposition: 2
Starting index for the list.
format System.Nullable{DocumentFormat.OpenXml.Wordprocessing.NumberFormatValues} requiredposition: 3
Numbering format for the list.
text System.String requiredposition: 4
Raw text pattern defining the marker.
leftIndentTwips System.Nullable{System.Int32} = null optionalposition: 5
List text position in twentieths of a point, when defined.
hangingIndentTwips System.Nullable{System.Int32} = null optionalposition: 6
List marker hanging indentation in twentieths of a point, when defined.
markerFontFamily System.String = null optionalposition: 7
Marker font family from the numbering level, when defined.
markerBold System.Nullable{System.Boolean} = null optionalposition: 8
Marker bold setting from the numbering level, when defined.
markerItalic System.Nullable{System.Boolean} = null optionalposition: 9
Marker italic setting from the numbering level, when defined.
markerColorHex System.String = null optionalposition: 10
Marker color from the numbering level, when defined.
levelJustification System.Nullable{DocumentFormat.OpenXml.Wordprocessing.LevelJustificationValues} = null optionalposition: 11
Marker justification from the numbering level, when defined.
levelSuffix System.Nullable{DocumentFormat.OpenXml.Wordprocessing.LevelSuffixValues} = null optionalposition: 12
Marker suffix from the numbering level, when defined.

Properties

public Int32 Level { get; } #

Zero-based nesting level.

public Boolean Ordered { get; } #

Indicates whether numbering is used.

public Int32 Start { get; } #

Starting index for the list.

public Nullable<NumberFormatValues> NumberFormat { get; } #

Numbering format applied to the list.

public String LevelText { get; } #

Pattern used to build the list marker.

public Nullable<Int32> LeftIndentTwips { get; } #

List text position in twentieths of a point, when defined.

public Nullable<Int32> HangingIndentTwips { get; } #

List marker hanging indentation in twentieths of a point, when defined.

public String MarkerFontFamily { get; } #

Marker font family from the numbering level, when defined.

public Nullable<Boolean> MarkerBold { get; } #

Marker bold setting from the numbering level, when defined.

public Nullable<Boolean> MarkerItalic { get; } #

Marker italic setting from the numbering level, when defined.

public String MarkerColorHex { get; } #

Marker color from the numbering level, when defined.

public Nullable<Double> MarkerFontSize { get; } #

Marker font size from the numbering level, in points, when defined.

public Nullable<LevelJustificationValues> LevelJustification { get; } #

Marker justification from the numbering level, when defined.

public Nullable<LevelSuffixValues> LevelSuffix { get; } #

Marker suffix from the numbering level, when defined.