Paper Office
paper-docxAPI referenceoxml.shape

CT_Inline

paper-docx 0.2.0 API reference

<wp:inline> element, container for an inline shape.

Attributes

docPr

attributedocPrCT_NonVisualDrawingProps
= OneAndOnlyOne('wp:docPr')

extent

attributeextentCT_PositiveSize2D
= OneAndOnlyOne('wp:extent')

graphic

attributegraphicCT_GraphicalObject
= OneAndOnlyOne('a:graphic')

xml

attributexmlstr

XML string for this element, suitable for testing purposes.

Pretty printed for readability and without an XML declaration at the top.

Functions

first_child_found_in

funcfirst_child_found_in(*tagnames: str) -> _Element | None

First child with tag in tagnames, or None if not found.

paramtagnamesstr
= ()

Returns

lxml.etree._Element | None

insert_element_before

funcinsert_element_before(elm: ElementBase, *tagnames: str)
paramelmElementBase
paramtagnamesstr
= ()

new

funcnew(cx: Length, cy: Length, shape_id: int, pic: CT_Picture) -> CT_Inline

Return a new <wp:inline> element populated with the values passed as parameters.

paramcxLength
paramcyLength
paramshape_idint
parampicCT_Picture

Returns

docx.oxml.shape.CT_Inline

new_pic_inline

funcnew_pic_inline(shape_id: int, rId: str, filename: str, cx: Length, cy: Length) -> CT_Inline

Create wp:inline element containing a pic:pic element.

The contents of the pic:pic element is taken from the argument values.

paramshape_idint
paramrIdstr
paramfilenamestr
paramcxLength
paramcyLength

Returns

docx.oxml.shape.CT_Inline

remove_all

funcremove_all(*tagnames: str) -> None

Remove child elements with tagname (e.g. "a:p") in tagnames.

paramtagnamesstr
= ()

Returns

None

xpath

funcxpath(xpath_str: str) -> Any

Override of lxml _Element.xpath() method.

Provides standard Open XML namespace mapping (nsmap) in centralized location.

paramxpath_strstr

Returns

typing.Any

On this page