ListFormat

ListFormat class

允许控制应用于段落的列表格式。

要了解更多信息,请访问使用列表文档文章。

public class ListFormat

特性

姓名描述
IsListItem { get; }当段落应用了项目符号或编号格式时为真。
List { get; set; }获取或设置此段落所属的列表。
ListLevel { get; }返回列表级别格式以及应用于当前段落的任何格式覆盖。
ListLevelNumber { get; set; }获取或设置段落的列表级别编号(0 到 8)。

方法

姓名描述
ApplyBulletDefault()启动新的默认项目符号列表并将其应用于段落。
ApplyNumberDefault()启动新的默认编号列表并将其应用于段落。
ListIndent()将当前段落的列表级别增加一级。
ListOutdent()将当前段落的列表级别降低一级。
RemoveNumbers()从当前段落中删除数字或项目符号并将列表级别设置为零。

评论

Microsoft Word 文档中的段落可以添加项目符号或编号。 当段落添加项目符号或编号时,表示列表格式 应用于该段落。

您不创建对象ListFormat直接类. 您访问ListFormat作为另一个对象的属性,can 具有与其关联的列表格式。目前 can 具有列表格式的对象是:Paragraph, StyleDocumentBuilder

ListFormat的一个Paragraph指定 应用于该特定段落的列表格式和列表级别。

ListFormat的一个Style (仅适用于段落样式)允许指定应用于该特定样式的所有段落的列表格式和列表 level 。

ListFormat的一个DocumentBuilder 提供对当前光标位置 内的列表格式的访问DocumentBuilder

列表格式本身存储在List 与段落分开存储的对象。列表objects 存储在ListCollection收藏。有一个 ListCollection每收集Document

这些段落实际上不属于列表。段落 just 通过Listproperty 和列表中的特定级别ListLevelNumberproperty. 通过设置这两个属性,您可以控制应用于段落的项目符号和编号 。

例子

展示如何使用列表级别。

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Assert.False(builder.ListFormat.IsListItem);

// 列表允许我们使用前缀符号和缩进来组织和装饰段落集。
 // 我们可以通过增加缩进级别来创建嵌套列表。
 // 我们可以使用文档构建器的“ListFormat”属性来开始和结束列表。
// 我们在列表的开头和结尾之间添加的每个段落都将成为列表中的一个项目。
// 下面是我们可以使用文档生成器创建的两种类型的列表。
// 1 - 编号列表:
// 编号列表通过对每个项目进行编号来为其段落创建逻辑顺序。
builder.ListFormat.List = doc.Lists.Add(ListTemplate.NumberDefault);

Assert.True(builder.ListFormat.IsListItem);

// 通过设置“ListLevelNumber”属性,我们可以增加列表级别
// 在当前列表项处开始一个独立的子列表。
// 名为“NumberDefault”的 Microsoft Word 列表模板使用数字为第一个列表级别创建列表级别。
 // 更深的列表级别使用字母和小写罗马数字。
for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 2 - 项目符号列表:
// 此列表将在每个段落之前应用缩进和项目符号(“•”)。
// 此列表的更深层次将使用不同的符号,例如“■”和“○”。
builder.ListFormat.List = doc.Lists.Add(ListTemplate.BulletDefault);

for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 我们可以通过取消设置“List”标志来禁用列表格式,以不将任何后续段落格式化为列表。
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

doc.Save(ArtifactsDir + "Lists.SpecifyListLevel.docx");

也可以看看