Paper Office
paper-docxAPI referenceparts.styles

StylesPart

paper-docx 0.2.0 API reference

Proxy for the styles.xml part containing style definitions for a document or glossary.

Attributes

blob

attributeblob

content_type

attributecontent_type

Content type of this part.

element

attributeelement

The root XML element of this XML part.

package

attributepackage

OpcPackage instance this part belongs to.

part

attributepart

Part of the parent protocol, "children" of the document will not know the part that contains them so must ask their parent object.

That chain of delegation ends here for child objects.

partname

attributepartname

PackURI instance holding partname of this part, e.g. '/ppt/slides/slide1.xml'.

attributerelated_parts

Dictionary mapping related parts by rId, so child objects can resolve explicit relationships present in the part XML, e.g. sldIdLst to a specific Slide instance.

rels

attributerels

Relationships instance holding the relationships for this part.

styles

attributestyles

The _Styles instance containing the styles (<w:style> element proxies) for this styles part.

Functions

after_unmarshal

funcafter_unmarshal()

Entry point for post-unmarshaling processing, for example to parse the part XML.

May be overridden by subclasses without forwarding call to super.

before_marshal

funcbefore_marshal()

Entry point for pre-serialization processing, for example to finalize part naming if necessary.

May be overridden by subclasses without forwarding call to super.

default

funcdefault(package: OpcPackage) -> StylesPart

Return a newly created styles part, containing a default set of elements.

parampackageOpcPackage

Returns

docx.parts.styles.StylesPart

drop_rel

funcdrop_rel(rId: str)

Remove the relationship identified by rId if its reference count is less than 2.

Relationships with a reference count of 0 are implicit relationships.

paramrIdstr

load

funcload(partname: PackURI, content_type: str, blob: bytes, package: Package)
parampartnamePackURI
paramcontent_typestr
paramblobbytes
parampackagePackage

load_rel

funcload_rel(reltype: str, target: Part | str, rId: str, is_external: bool = False)

Return newly added _Relationship instance of reltype.

The new relationship relates the target part to this part with key rId.

Target mode is set to RTM.EXTERNAL if is_external is True. Intended for use during load from a serialized package, where the rId is well-known. Other methods exist for adding a new relationship to a part when manipulating a part.

paramreltypestr
paramtargetPart | str
paramrIdstr
paramis_externalbool
= False
funcpart_related_by(reltype: str) -> Part

Return part to which this part has a relationship of reltype.

Raises KeyError if no such relationship is found and ValueError if more than one such relationship is found. Provides ability to resolve implicitly related part, such as Slide -> SlideLayout.

paramreltypestr

Returns

docx.opc.part.Part

relate_to

funcrelate_to(target: Part | str, reltype: str, is_external: bool = False) -> str

Return rId key of relationship of reltype to target.

The returned rId is from an existing relationship if there is one, otherwise a new relationship is created.

paramtargetPart | str
paramreltypestr
paramis_externalbool
= False

Returns

str

target_ref

functarget_ref(rId: str) -> str

Return URL contained in target ref of relationship identified by rId.

paramrIdstr

Returns

str

On this page