导航

  • 索引
  • 下一页 |
  • 上一页 |
  • python-docx 0.8.10 文档 »
  • 样式相关对象

样式相关对象¶

样式用于收集单个名称下的一组格式属性,并将这些属性一次性应用于内容对象。这可以提高整个文档和相关文档之间的格式一致性,并允许通过以适当的样式更改定义来全局更改格式。

Styles 对象¶

class docx.styles.styles.Styles[源代码]¶

提供对文档中定义的样式的访问。

使用 Document.styles 属性。支持 len() 、迭代和按样式名的字典样式访问。

add_style(name, style_type, builtin=False)[源代码]¶

返回新添加的样式对象 style_type 并由 name . 可以通过为可选的传递True来定义内置样式 内建 争论。

default(style_type)[源代码]¶

返回的默认样式 style_type 或 None 如果没有为该类型定义默认值(不常见)。

property element¶

此对象代理的lxml元素。

property latent_styles¶

A LatentStyles object providing access to the default behaviors for latent styles and the collection of |_ LatentStyle |对象,为特定命名的潜在样式定义这些默认值的覆盖。

BaseStyle 对象¶

class docx.styles.style.BaseStyle[源代码]¶

各种样式对象、段落、字符、表和编号的基类。这些属性和方法由所有样式对象继承。

property builtin¶

只读。 True 如果此样式是内置样式。 False 指示它是自定义(用户定义)样式。注意此值基于 customStyle 属性,而不是基于在Word中内置哪些样式的特定知识。

delete()[源代码]¶

从文档中删除此样式定义。请注意,调用此方法不会删除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现,与文档中未定义样式的任何内容一样。

property element¶

此对象代理的lxml元素。

property hidden¶

True 如果样式库和推荐样式列表中此样式的显示被抑制。 False 否则。要在样式库中显示,此值必须为 False 和 quick_style 必须是 True .

property locked¶

读/写布尔值。 True 如果此样式被锁定。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property name¶

此样式的UI名称。

property priority¶

控制Word UI中此样式的显示顺序的整数排序键。 None 指示未定义任何设置,导致Word使用默认值0。与排序样式具有相同优先级的排序样式的第二个值。

property quick_style¶

True 如果此样式应在样式库中显示,则 hidden 是 False . 读/写布尔值。

property type¶

成员 WD_STYLE_TYPE 与此样式的类型相对应,例如。 WD_STYLE_TYPE.PARAGRAPH .

property unhide_when_used¶

True 如果应用程序下次将此样式应用于内容时应使其可见。否则为假。请注意 python-docx 不会自动取消隐藏具有 True 将此属性应用于内容时。

_CharacterStyle 对象¶

class docx.styles.style._CharacterStyle[源代码]¶

基类:docx.styles.style.BaseStyle

一种性格风格。字符样式应用于 Run 对象,并主要通过 Font 对象中 font 属性。

property base_style¶

此样式继承自或的样式对象 None 如果此样式不基于其他样式。

property builtin¶

只读。 True 如果此样式是内置样式。 False 指示它是自定义(用户定义)样式。注意此值基于 customStyle 属性,而不是基于在Word中内置哪些样式的特定知识。

delete()¶

从文档中删除此样式定义。请注意,调用此方法不会删除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现,与文档中未定义样式的任何内容一样。

property font¶

这个 Font 对象提供对此样式的字符格式属性(如字体名称和大小)的访问。

property hidden¶

True 如果样式库和推荐样式列表中此样式的显示被抑制。 False 否则。要在样式库中显示,此值必须为 False 和 quick_style 必须是 True .

property locked¶

读/写布尔值。 True 如果此样式被锁定。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property name¶

此样式的UI名称。

property priority¶

控制Word UI中此样式的显示顺序的整数排序键。 None 指示未定义任何设置,导致Word使用默认值0。与排序样式具有相同优先级的排序样式的第二个值。

property quick_style¶

True 如果此样式应在样式库中显示,则 hidden 是 False . 读/写布尔值。

property unhide_when_used¶

True 如果应用程序下次将此样式应用于内容时应使其可见。否则为假。请注意 python-docx 不会自动取消隐藏具有 True 将此属性应用于内容时。

_ParagraphStyle 对象¶

class docx.styles.style._ParagraphStyle[源代码]¶

基类:docx.styles.style._CharacterStyle

段落风格。段落样式同时提供字符格式和段落格式(如缩进和行距)。

property base_style¶

此样式继承自或的样式对象 None 如果此样式不基于其他样式。

property builtin¶

只读。 True 如果此样式是内置样式。 False 指示它是自定义(用户定义)样式。注意此值基于 customStyle 属性,而不是基于在Word中内置哪些样式的特定知识。

delete()¶

从文档中删除此样式定义。请注意,调用此方法不会删除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现,与文档中未定义样式的任何内容一样。

property font¶

这个 Font 对象提供对此样式的字符格式属性(如字体名称和大小)的访问。

property hidden¶

True 如果样式库和推荐样式列表中此样式的显示被抑制。 False 否则。要在样式库中显示,此值必须为 False 和 quick_style 必须是 True .

property locked¶

读/写布尔值。 True 如果此样式被锁定。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property name¶

此样式的UI名称。

property next_paragraph_style¶

_ParagraphStyle 对象,该对象表示要自动应用于在此样式的段落之后插入的新段落的样式。如果未定义下一段落样式,则返回self。分配 None 或 self 删除设置,以便使用相同的样式创建新段落。

property paragraph_format¶

这个 ParagraphFormat 对象提供对此样式的段落格式属性(如缩进)的访问。

property priority¶

控制Word UI中此样式的显示顺序的整数排序键。 None 指示未定义任何设置,导致Word使用默认值0。与排序样式具有相同优先级的排序样式的第二个值。

property quick_style¶

True 如果此样式应在样式库中显示,则 hidden 是 False . 读/写布尔值。

property unhide_when_used¶

True 如果应用程序下次将此样式应用于内容时应使其可见。否则为假。请注意 python-docx 不会自动取消隐藏具有 True 将此属性应用于内容时。

_TableStyle 对象¶

class docx.styles.style._TableStyle[源代码]¶

基类:docx.styles.style._ParagraphStyle

表格样式。表格样式为其内容提供字符和段落格式以及特殊的表格格式属性。

property base_style¶

此样式继承自或的样式对象 None 如果此样式不基于其他样式。

property builtin¶

只读。 True 如果此样式是内置样式。 False 指示它是自定义(用户定义)样式。注意此值基于 customStyle 属性,而不是基于在Word中内置哪些样式的特定知识。

delete()¶

从文档中删除此样式定义。请注意,调用此方法不会删除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现,与文档中未定义样式的任何内容一样。

property font¶

这个 Font 对象提供对此样式的字符格式属性(如字体名称和大小)的访问。

property hidden¶

True 如果样式库和推荐样式列表中此样式的显示被抑制。 False 否则。要在样式库中显示,此值必须为 False 和 quick_style 必须是 True .

property locked¶

读/写布尔值。 True 如果此样式被锁定。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property name¶

此样式的UI名称。

property next_paragraph_style¶

_ParagraphStyle 对象,该对象表示要自动应用于在此样式的段落之后插入的新段落的样式。如果未定义下一段落样式,则返回self。分配 None 或 self 删除设置,以便使用相同的样式创建新段落。

property paragraph_format¶

这个 ParagraphFormat 对象提供对此样式的段落格式属性(如缩进)的访问。

property priority¶

控制Word UI中此样式的显示顺序的整数排序键。 None 指示未定义任何设置,导致Word使用默认值0。与排序样式具有相同优先级的排序样式的第二个值。

property quick_style¶

True 如果此样式应在样式库中显示,则 hidden 是 False . 读/写布尔值。

property unhide_when_used¶

True 如果应用程序下次将此样式应用于内容时应使其可见。否则为假。请注意 python-docx 不会自动取消隐藏具有 True 将此属性应用于内容时。

_NumberingStyle 对象¶

class docx.styles.style._NumberingStyle[源代码]¶

编号样式。尚未实施。

LatentStyles 对象¶

class docx.styles.latent.LatentStyles[源代码]¶

提供对此文档中潜在样式的默认行为和 _LatentStyle 为特定命名的潜在样式定义这些默认值的重写的对象。

add_latent_style(name)[源代码]¶

返回新添加的 _LatentStyle 对象重写在该潜在样式对象中定义的继承的默认值 name .

property default_priority¶

0到99之间的整数,指定样式列表和样式库中潜在样式的默认排序顺序。 None 如果未指定值,则Word将使用默认值99。

property default_to_hidden¶

布尔值,指定是否隐藏潜在样式的默认行为。隐藏的样式不会出现在推荐列表或样式库中。

property default_to_locked¶

布尔值,指定是否要锁定潜在样式的默认行为。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property default_to_quick_style¶

布尔值,指定隐藏样式的默认行为是否在未隐藏时显示在样式库中。

property default_to_unhide_when_used¶

布尔值,指定第一次应用于内容时是否隐藏潜在样式的默认行为。

property element¶

此对象代理的lxml元素。

property load_count¶

指定要初始化为此中指定的默认值的内置样式数的整数 LatentStyles 对象。 None 如果XML中没有设置(非常罕见)。默认的word2011模板将此值设置为276,说明word2010中的内置样式。

_LatentStyle 对象¶

class docx.styles.latent._LatentStyle[源代码]¶

代理 w:lsdException 元素,该元素指定在中尚未存储内置样式的定义时该样式的显示行为 styles.xml 部分。此元素中的值覆盖父元素中指定的默认值 w:latentStyles 元素。

delete()[源代码]¶

删除此潜在样式定义,以便在包含 LatentStyles 对象为其每个属性提供有效值。调用此方法后尝试访问此对象上的任何属性将引发 AttributeError .

property element¶

此对象代理的lxml元素。

property hidden¶

指定此潜在样式是否应出现在推荐列表中的三态值。 None 指示有效值是从父级继承的 <w:latentStyles> 元素。

property locked¶

指定是否锁定此潜在样式的三态值。锁定的样式不会出现在“样式”面板或样式库中,并且无法应用于文档内容。(仅当“开发人员”菜单中的“保护”处于活动状态时,才打开“保护”菜单)。

property name¶

此异常应用于的内置样式的名称。

property priority¶

Word UI中此潜在样式的整数排序键。

property quick_style¶

三态值,指定此隐藏样式在未隐藏时是否应显示在Word样式库中。 None 指示有效值应从其父级中的默认值继承 LatentStyles 对象。

property unhide_when_used¶

指定此样式是否应具有 hidden 属性集 False 下次将样式应用于内容时。 None 默认情况下从父级继承指定的有效值 LatentStyles 对象。

目录

  • 样式相关对象
    • Styles 对象
    • BaseStyle 对象
    • _CharacterStyle 对象
    • _ParagraphStyle 对象
    • _TableStyle 对象
    • _NumberingStyle 对象
    • LatentStyles 对象
    • _LatentStyle 对象

上一个主题

文件 Settings 对象

下一个主题

文本相关对象

Useful Links

  • python-docx @ GitHub
  • python-docx @ PyPI
  • Issue Tracker

快速搜索

导航

  • 索引
  • 下一页 |
  • 上一页 |
  • python-docx 0.8.10 文档 »
  • 样式相关对象
© Copyright 2013, Steve Canny. Created using Sphinx 3.2.1.
Theme based on Read The Docs