OleObjectFrame class

Represents an OLE object on a slide.

Inheritance:OleObjectFrame → GraphicalObject → Shape

The OleObjectFrame type exposes the following members:

Properties

Property	Description
`is_text_holder`	Determines whether the shape is TextHolder_PPT. Read-only bool.
`placeholder`	Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only `IPlaceholder`.
`custom_data`	Returns the shape’s custom data. Read-only `ICustomData`.
`raw_frame`	Returns or sets the raw shape frame’s properties. Read/write `IShapeFrame`.
`frame`	Returns or sets the shape frame’s properties. Read/write `IShapeFrame`.
`line_format`	Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don’t have line properties. Read-only `ILineFormat`.
`three_d_format`	Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don’t have 3d properties. Read-only `IThreeDFormat`.
`effect_format`	Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don’t have effect properties. Read-only `IEffectFormat`.
`fill_format`	Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only `IFillFormat`.
`hyperlink_click`	Returns or sets the hyperlink defined for mouse click. Read/write `IHyperlink`.
`hyperlink_mouse_over`	Returns or sets the hyperlink defined for mouse over. Read/write `IHyperlink`.
`hyperlink_manager`	Returns the hyperlink manager. Read-only `IHyperlinkManager`.
`hidden`	Determines whether the shape is hidden. Read/write bool.
`z_order_position`	Returns 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 int.
`connection_site_count`	Returns the number of connection sites on the shape. Read-only int.
`rotation`	Returns 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 float.
`x`	Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float.
`y`	Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float.
`width`	Returns or sets the width of the shape. Read/write float.
`height`	Returns or sets the height of the shape. Read/write float.
`black_white_mode`	Property specifies how a shape will render in black-and-white display mode.. Read/write `BlackWhiteMode`.
`unique_id`	Gets unique shape identifier in presentation scope. Read-only int. See also `Shape.office_interop_shape_id` for getting unique shape identifier in slide scope.
`office_interop_shape_id`	Gets unique shape identifier in slide scope. Read-only int. See also `Shape.unique_id` for getting unique shape identifier in presentation scope.
`alternative_text`	Returns or sets the alternative text associated with a shape. Read/write str.
`alternative_text_title`	Returns or sets the title of alternative text associated with a shape. Read/write str.
`name`	Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write str.
`is_decorative`	Gets or sets ‘Mark as decorative’ option Reed/write bool.
`shape_lock`	Returns shape’s locks. Read-only `IGraphicalObjectLock`.
`is_grouped`	Determines whether the shape is grouped. Read-only bool.
`parent_group`	Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only `IGroupShape`.
`slide`	Returns the parent slide of a shape. Read-only `IBaseSlide`.
`presentation`	Returns the parent presentation of a slide. Read-only `IPresentation`.
`graphical_object_lock`	Returns shape’s locks. Read-only `IGraphicalObjectLock`.
`substitute_picture_format`	Returns OleObject image fill properties object. Read-only `IPictureFillFormat`.
`substitute_picture_title`	Returns or sets the title for OleObject icon. Read/write str.
`object_name`	Returns or sets the name of an object. Read/write str.
`object_prog_id`	Returns the ProgID of an object. Read only str.
`link_file_name`	Returns the full path to a linked file. Short file name will be used. Read-only str.
`link_path_long`	Returns the full path to a linked file. Long file name will be used. Read/write str.
`link_path_relative`	Returns the relative path to a linked file if present, otherwise returns an empty string. Readonly str.
`embedded_file_label`	Returns the file name of embedded OLE object
`embedded_file_name`	Returns the path of embedded OLE object
`embedded_data`	Gets or sets information about OLE embedded data. Read/write `IOleEmbeddedDataInfo`.
`is_object_icon`	Determines whether an object is visible as icon. Read/write bool.
`is_object_link`	Determines whether an object is linked to external file. Read-only bool.
`update_automatic`	Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read/write bool.

Methods

Method	Description
`get_thumbnail`	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
`get_thumbnail`	Returns shape thumbnail.
`get_image`	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
`get_image`	Returns shape thumbnail.
`write_as_svg`	Saves content of Shape as SVG file.
`write_as_svg`	Saves content of Shape as SVG file.
`remove_placeholder`	Defines that this shape isn’t a placeholder.
`add_placeholder`	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). A null is returned if the current shape is not inherited.
`set_embedded_data`	Sets information about OLE embedded data. This method changes the properties of the object to reflect the new data and sets the IsObjectLink flag to false, indicating that the OLE object is embedded.

OleObjectFrame class

OleObjectFrame class

Properties

Methods

See Also