样式相关对象¶
样式用于收集单个名称下的一组格式属性，并将这些属性一次性应用于内容对象。这提高了整个文档和相关文档的格式一致性，并允许通过更改适当样式中的定义来全局更改格式。
Styles 对象¶
- class docx.styles.styles.Styles[源代码]¶
提供对文档中定义的样式的访问。
使用
Document.styles属性。支持len()、迭代和按样式名的字典样式访问。- add_style(name, style_type, builtin=False)[源代码]¶
返回新添加的样式对象 style_type 并通过以下方式识别 name 。
可以通过为可选的 builtin 争论。
- property element¶
此对象代理的lxml元素。
- property latent_styles¶
A
LatentStylesobject 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中内置了哪些样式的特定了解。
- 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 type¶
成员 WD_STYLE_TYPE 与此样式的类型相对应，例如。
WD_STYLE_TYPE.PARAGRAPH.
- property unhide_when_used¶
True应用程序是否应在下次将此样式应用于内容时使其可见。否则就是假的。请注意
python-docx不会自动取消隐藏具有True此属性应用于内容时的。
CharacterStyle 对象¶
- class docx.styles.style.CharacterStyle[源代码]¶
基类：
BaseStyle一种角色风格。
字符样式应用于
Run对象，并主要通过Font对象在其font财产。- property base_style¶
此样式继承自或的样式对象
None如果此样式不基于其他样式。
- property builtin¶
只读。
True如果此样式是内置样式。False指示它是自定义(用户定义的)样式。注意：该值基于存在 customStyle 属性，而不是基于对Word中内置了哪些样式的特定了解。
- delete()¶
从文档中删除此样式定义。
请注意，调用此方法不会移除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现，文档中未定义样式的任何内容也是如此。
- property hidden¶
True如果此样式在样式库和推荐样式列表中的显示被抑制。False否则的话。要在样式库中显示，此值必须为False和quick_style一定是True。
- property locked¶
读/写布尔值。
True如果此样式已锁定。锁定的样式不会显示在样式面板或样式库中，也不能应用于文档内容。只有在为文档启用了格式保护(通过开发人员菜单)时，此行为才有效。
- property name¶
此样式的UI名称。
- property priority¶
控制此样式在Word UI中的显示顺序的整数排序关键字。
None指示未定义任何设置，导致Word使用默认值0。样式名称用作次要排序关键字，以解析具有相同优先级值的样式的排序。
- property unhide_when_used¶
True应用程序是否应在下次将此样式应用于内容时使其可见。否则就是假的。请注意
python-docx不会自动取消隐藏具有True此属性应用于内容时的。
ParagraphStyle 对象¶
- class docx.styles.style.ParagraphStyle[源代码]¶
-
段落样式。
段落样式提供字符格式和段落格式，如缩进和行距。
- property base_style¶
此样式继承自或的样式对象
None如果此样式不基于其他样式。
- property builtin¶
只读。
True如果此样式是内置样式。False指示它是自定义(用户定义的)样式。注意：该值基于存在 customStyle 属性，而不是基于对Word中内置了哪些样式的特定了解。
- delete()¶
从文档中删除此样式定义。
请注意，调用此方法不会移除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现，文档中未定义样式的任何内容也是如此。
- 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 unhide_when_used¶
True应用程序是否应在下次将此样式应用于内容时使其可见。否则就是假的。请注意
python-docx不会自动取消隐藏具有True此属性应用于内容时的。
_TableStyle 对象¶
- class docx.styles.style._TableStyle[源代码]¶
-
一种表格样式。
表格样式为其内容提供字符和段落格式设置以及特殊的表格格式属性。
- property base_style¶
此样式继承自或的样式对象
None如果此样式不基于其他样式。
- property builtin¶
只读。
True如果此样式是内置样式。False指示它是自定义(用户定义的)样式。注意：该值基于存在 customStyle 属性，而不是基于对Word中内置了哪些样式的特定了解。
- delete()¶
从文档中删除此样式定义。
请注意，调用此方法不会移除或更改应用于任何文档内容的样式。具有已删除样式的内容项将使用默认样式呈现，文档中未定义样式的任何内容也是如此。
- 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 unhide_when_used¶
True应用程序是否应在下次将此样式应用于内容时使其可见。否则就是假的。请注意
python-docx不会自动取消隐藏具有True此属性应用于内容时的。
_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中没有设置(非常罕见)。默认的Word 2011模板将此值设置为276，考虑到Word 2010中的内置样式。
_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对象。