Paper Office
paper-pptxAPI referenceshapes.placeholder

MasterPlaceholder

paper-pptx 0.2.0 API reference

Placeholder shape on a slide master.

Attributes

adjustments

attributeadjustmentsAdjustmentCollection

Read-only reference to AdjustmentCollection instance for this shape.

auto_shape_type

attributeauto_shape_type

Enumeration value identifying the type of this auto shape.

Like MSO_SHAPE.ROUNDED_RECTANGLE. Raises ValueError if this shape is not an auto shape.

click_action

attributeclick_actionActionSetting

ActionSetting instance providing access to click behaviors.

Click behaviors are hyperlink-like behaviors including jumping to a hyperlink (web page) or to another slide in the presentation. The click action is that defined on the overall shape, not a run of text within the shape. An ActionSetting object is always returned, even when no click behavior is defined on the shape.

element

attributeelementCT_Shape

fill

attributefill

FillFormat instance for this shape.

Provides access to fill properties such as fill color.

has_chart

attributehas_chartbool

True if this shape is a graphic frame containing a chart object.

False otherwise. When True, the chart object can be accessed using the .chart property.

has_table

attributehas_tablebool

True if this shape is a graphic frame containing a table object.

False otherwise. When True, the table object can be accessed using the .table property.

has_text_frame

attributehas_text_framebool

True if this shape can contain text. Always True for an AutoShape.

height

attributeheightLength

Read/write. Integer distance between top and bottom extents of shape in EMUs.

idx

attributeidx

Integer placeholder 'idx' attribute, e.g. 0

is_placeholder

attributeis_placeholderbool

True if this shape is a placeholder.

A shape is a placeholder if it has a <p:ph> element.

left

attributeleftLength

Integer distance of the left edge of this shape from the left edge of the slide.

Read/write. Expressed in English Metric Units (EMU)

line

attributeline

LineFormat instance for this shape.

Provides access to line properties such as line color.

ln

attributeln

The a:ln element containing the line format properties such as line color and width.

None if no a:ln element is present.

name

attributenamestr

Name of this shape, e.g. 'Picture 7'.

orient

attributeorient

Placeholder orientation, e.g. ST_Direction.HORZ

part

attributepartBaseSlidePart

The package part containing this shape.

A BaseSlidePart subclass in this case. Access to a slide part should only be required if you are extending the behavior of pp API objects.

ph_type

attributeph_type

Placeholder type, e.g. PP_PLACEHOLDER.CENTER_TITLE

placeholder_format

attributeplaceholder_format_PlaceholderFormat

Provides access to placeholder-specific properties such as placeholder type.

Raises ValueError on access if the shape is not a placeholder.

rotation

attributerotationfloat

Degrees of clockwise rotation.

Read/write float. Negative values can be assigned to indicate counter-clockwise rotation, e.g. assigning -45.0 will change setting to 315.0.

shadow

attributeshadowShadowFormat

ShadowFormat object providing access to shadow for this shape.

A ShadowFormat object is always returned, even when no shadow is explicitly defined on this shape (i.e. it inherits its shadow behavior).

shape_id

attributeshape_idint

Read-only positive integer identifying this shape.

The id of a shape is unique among all shapes on a slide.

shape_type

attributeshape_typeMSO_SHAPE_TYPE

Unique integer identifying the type of this shape, like MSO_SHAPE_TYPE.TEXT_BOX.

sz

attributesz

Placeholder 'sz' attribute, e.g. ST_PlaceholderSize.FULL

text

attributetextstr

Read/write. Text in shape as a single string.

The returned string will contain a newline character ("\n") separating each paragraph and a vertical-tab ("\v") character for each line break (soft carriage return) in the shape's text.

Assignment to text replaces any text previously contained in the shape, along with any paragraph or font formatting applied to it. A newline character ("\n") in the assigned text causes a new paragraph to be started. A vertical-tab ("\v") character in the assigned text causes a line-break (soft carriage-return) to be inserted. (The vertical-tab character appears in clipboard text copied from PowerPoint as its str encoding of line-breaks.)

text_frame

attributetext_frame

TextFrame instance for this shape.

Contains the text of the shape and provides access to text formatting properties.

top

attributetopLength

Distance from the top edge of the slide to the top edge of this shape.

Read/write. Expressed in English Metric Units (EMU)

width

attributewidthLength

Distance between left and right extents of this shape.

Read/write. Expressed in English Metric Units (EMU).

Functions

get_or_add_ln

funcget_or_add_ln()

Return the a:ln element containing the line format properties XML for this shape.

On this page