AutoShape

AutoShape class

Represents an AutoShape.

The AutoShape type exposes the following members:

Properties

NameDescription
is_text_holderDetermines whether the shape is TextHolder.
Read-only bool.
placeholderReturns the placeholder for a shape.
Read-only IPlaceholder.
custom_dataReturns the shape’s custom data.
Read-only ICustomData.
raw_frameReturns or sets the raw shape frame’s properties.
Read/write IShapeFrame.
frameReturns or sets the shape frame’s properties.
Read/write IShapeFrame.
line_formatReturns the LineFormat object that contains line formatting properties for a shape.
Read-only ILineFormat.
three_d_formatReturns the ThreeDFormat object that contains line formatting properties for a shape.
Read-only IThreeDFormat.
effect_formatReturns the EffectFormat object which contains pixel effects applied to a shape.
Read-only IEffectFormat.
fill_formatReturns the FillFormat object that contains fill formatting properties for a shape.
Read-only IFillFormat.
hyperlink_clickReturns or sets the hyperlink defined for mouse click.
Read/write IHyperlink.
hyperlink_mouse_overReturns or sets the hyperlink defined for mouse over.
Read/write IHyperlink.
hyperlink_managerHyperlinks manager
Read-only IHyperlinkManager.
hiddenDetermines whether the shape is hidden.
Read/write bool.
z_order_positionReturns the position of a shape in the z-order.
Shapes[0] returns the shape at the back of the z-order,
and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.
Read-only
connection_site_countReturns the number of connection sites on the shape.
Read-only
rotationReturns or sets the number of degrees the specified shape is rotated around
the z-axis. A positive value indicates clockwise rotation; a negative value
indicates counterclockwise rotation.
Read/write
xReturns or sets the x-coordinate of the upper-left corner of the shape.
Read/write
yReturns or sets the y-coordinate of the upper-left corner of the shape.
Read/write
widthReturns or sets the width of the shape.
Read/write
heightReturns or sets the height of the shape.
Read/write
black_white_modeProperty specifies how a shape will render in black-and-white display mode..
Read/write BlackWhiteMode.
unique_idGets unique shape identifier in presentation scope.
Read-only int.
See also office_interop_shape_id for getting unique shape identifier in slide scope.
office_interop_shape_idGets unique shape identifier in slide scope.
Read-only int.
See also unique_id for getting unique shape identifier in presentation scope.
alternative_textReturns or sets the alternative text associated with a shape.
Read/write string.
alternative_text_titleReturns or sets the title of alternative text associated with a shape.
Read/write string.
nameReturns or sets the name of a shape.
Read/write string.
is_decorativeGets or sets ‘Mark as decorative’ option
Reed/write bool.
shape_lockReturns shape’s locks.
Read-only IAutoShapeLock.
is_groupedDetermines whether the shape is grouped.
Read-only bool.
parent_groupReturns parent GroupShape object if shape is grouped. Otherwise returns null.
Read-only IGroupShape.
slideReturns the base slide.
Read-only IBaseSlide.
presentationReturns the presentation.
Read-only IPresentation.
shape_styleReturns shape’s style object.
Read-only IShapeStyle.
shape_typeReturns or sets the geometry preset type.
Note: on value changing all adjustment values will reset to their default values.
Read/write ShapeType.
adjustmentsReturns a collection of shape’s adjustment values.
Read-only IAdjustValueCollection.
auto_shape_lockReturns autoshape’s locks.
Read-only IAutoShapeLock.
text_frameReturns TextFrame object for the AutoShape.
Read-only ITextFrame.
use_background_fillDetermines whether this autoshape should be filled with slide’s background fill instead of specified by style or fill format.
Read/write bool.
is_text_boxSpecifies if the shape is a text box.
as_i_hyperlink_containerAllows to get base IHyperlinkContainer interface.
Read-only IHyperlinkContainer.
as_i_slide_componentAllows to get base ISlideComponent interface.
Read-only ISlideComponent.
as_i_presentation_componentAllows to get base IPresentationComponent interface.
Read-only IPresentationComponent.
as_i_shapeAllows to get base IShape interface.
Read-only IShape.
as_i_geometry_shapeAllows to get base IGeometryShape interface.
Read-only IGeometryShape.

Methods

NameDescription
get_thumbnail()Returns shape thumbnail.
ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
get_thumbnail(bounds, scale_x, scale_y)Returns shape thumbnail.
write_as_svg(stream)Saves content of Shape as SVG file.
write_as_svg(stream, svg_options)Saves content of Shape as SVG file.
remove_placeholder()Defines that this shape isn’t a placeholder.
add_placeholder(placeholder_to_copy_from)Adds a new placeholder if there is no and sets placeholder properties to a specified one.
get_base_placeholder()Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from).
get_geometry_paths()Returns the copy of path of the geometry shape. Coordinates are relative to the left top corner of the shape.
set_geometry_path(geometry_path)Updates shape geometry from IGeometryPath object. Coordinates must be relative to the left
top corner of the shape.
Changes the type of the shape (shape_type) to CUSTOM.
set_geometry_paths(geometry_paths)Updates shape geometry from array of IGeometryPath. Coordinates must be relative to the left
top corner of the shape.
Changes the type of the shape (shape_type) to CUSTOM.
create_shape_elements()Creates and returns array of shape’s elements.
add_text_frame(text)Adds a new TextFrame to a shape.
If shape already has TextFrame then simply changes its text.

See Also