Table of Contents

Class OdfAlphabeticalIndex

Namespace
OdfKit.Text
Assembly
OdfKit.dll

Represents an alphabetical index in an ODF document. 表示 ODF 文件中的字母索引。

public class OdfAlphabeticalIndex : OdfIndex
Inheritance
OdfAlphabeticalIndex
Inherited Members

Constructors

OdfAlphabeticalIndex(OdfNode, TextDocument)

Initializes a new instance of the OdfAlphabeticalIndex class. 初始化 OdfAlphabeticalIndex 類別的新執行個體。

public OdfAlphabeticalIndex(OdfNode node, TextDocument doc)

Parameters

node OdfNode

The OdfNode of the alphabetical index. / 字母索引的 OdfNode 節點。

doc TextDocument

The owning text document. / 所屬的文字文件。

Properties

AlphabeticalSeparators

Gets or sets a value indicating whether alphabetical separators are used. 取得或設定一個值，指出是否使用字母分隔符號。

public bool AlphabeticalSeparators { get; set; }

Property Value

bool

CombineEntries

Gets or sets a value indicating whether identical index entries are combined. 取得或設定一個值，指出是否合併相同的索引專案。

public bool CombineEntries { get; set; }

Property Value

bool

IgnoreCase

Gets or sets a value indicating whether case is ignored when sorting the index. 取得或設定一個值，指出索引排序時是否忽略大小寫。

public bool IgnoreCase { get; set; }

Property Value

bool

Methods

AddEntryTemplate(string, string)

Adds an entry template for the alphabetical index. 新增字母索引專案範本。

public OdfIndexTemplateBuilder AddEntryTemplate(string outlineLevel, string styleName)

Parameters

outlineLevel string

The outline level. / 大綱階層。

styleName string

The style name. / 樣式名稱。

Returns

OdfIndexTemplateBuilder

An OdfIndexTemplateBuilder instance for constructing the template. / 用於建構範本的 OdfIndexTemplateBuilder 執行個體。

ConfigureSource()

Short overload of ConfigureSource that uses default values for all optional parameters and forwards to the full overload. 便利多載：ConfigureSource 的所有可選參數使用預設值並轉呼叫最長多載。

public void ConfigureSource()

ConfigureSource(bool)

Short overload of ConfigureSource that accepts commaSeparated; remaining optional parameters use defaults and forward to the full overload. 便利多載：提供 commaSeparated；其餘可選參數使用預設值並轉呼叫最長 ConfigureSource 多載。

public void ConfigureSource(bool commaSeparated)

Parameters

commaSeparated bool

ConfigureSource(bool, bool)

Configures the properties of the alphabetical index source. 設定字母索引來源的屬性。

public void ConfigureSource(bool commaSeparated, bool ignoreCase)

Parameters

commaSeparated bool

Whether to use comma separation. / 是否使用逗號分隔。

ignoreCase bool

Whether to ignore case. / 是否忽略大小寫。

GetSourceLocalName()

Gets the XML local name of the alphabetical index source node. 取得字母索引來源節點的 XML 本地名稱。

protected override string GetSourceLocalName()

Returns

string

The XML local name. / XML 本地名稱。

Update()

Updates the content of the alphabetical index. 更新字母索引的內容。

public override void Update()