Skip to main content
Ctrl+K

Table of Contents

  • Installing
  • Quickstart
  • Working with Documents
  • Working with Tables
  • Working with Text
  • Working with Sections
  • Working with Headers and Footers
  • API basics
  • Understanding Styles
  • Working with Styles
  • Working with Comments
  • Understanding pictures and other shapes
  • Working with custom properties
  • Working with customXml
  • Document objects
  • Document Settings objects
  • Style-related objects
  • Text-related objects
  • Table objects
  • Section objects
  • Comment-related objects
  • Shape-related objects
    • InlineShapes objects
    • InlineShape objects
  • DrawingML objects
  • Shared classes
  • Enumerations
  • Analysis

Useful Links

  • python-docx-oss @ GitHub
  • python-docx-oss @ PyPI
  • python-docx documentation
  • .rst

Shape-related objects

Contents

  • InlineShapes objects
    • InlineShapes
  • InlineShape objects
    • InlineShape
      • InlineShape.height
      • InlineShape.type
      • InlineShape.width

Shape-related objects#

InlineShapes objects#

class docx.shape.InlineShapes(body_elm: CT_Body, parent: StoryPart)[source]#

Sequence of InlineShape instances, supporting len(), iteration, and indexed access.

InlineShape objects#

The width and height property of InlineShape provide a length object that is an instance of Length. These instances behave like an int, but also have built-in units conversion properties, e.g.:

>>> inline_shape.height
914400
>>> inline_shape.height.inches
1.0
class docx.shape.InlineShape(inline: CT_Inline)[source]#

Proxy for an <wp:inline> element, representing the container for an inline graphical object.

property height: Length#

Read/write.

The display height of this inline shape as an Emu instance.

property type#

The type of this inline shape as a member of docx.enum.shape.WD_INLINE_SHAPE, e.g. LINKED_PICTURE.

Read-only.

property width#

Read/write.

The display width of this inline shape as an Emu instance.

previous

Comment-related objects

next

DrawingML objects

Contents
  • InlineShapes objects
    • InlineShapes
  • InlineShape objects
    • InlineShape
      • InlineShape.height
      • InlineShape.type
      • InlineShape.width

By Ethan St. Lee

© Copyright 2022, Ethan St. Lee.