OleObjectFrame

OleObjectFrame class

Represents an OLE object on a slide.

public class OleObjectFrame : GraphicalObject, IOleObjectFrame

Properties

NameDescription
AlternativeText { get; set; }Returns or sets the alternative text associated with a shape. Read/write String.
AlternativeTextTitle { get; set; }Returns or sets the title of alternative text associated with a shape. Read/write String.
AsIGraphicalObject { get; }Allows to get base IGraphicalObject interface. Read-only IGraphicalObject.
BlackWhiteMode { get; set; }Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.
ConnectionSiteCount { get; }Returns the number of connection sites on the shape. Read-only Int32.
CustomData { get; }Returns the shape’s custom data. Read-only ICustomData.
virtual EffectFormat { get; }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.
EmbeddedData { get; }Gets or sets information about OLE embedded data. Read/write IOleEmbeddedDataInfo.
EmbeddedFileLabel { get; }Returns the file name of embedded OLE object
EmbeddedFileName { get; }Returns the path of embedded OLE object
virtual FillFormat { get; }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.
Frame { get; set; }Returns or sets the shape frame’s properties. Read/write IShapeFrame.
GraphicalObjectLock { get; }Returns shape’s locks. Read-only IGraphicalObjectLock.
Height { get; set; }Returns or sets the height of the shape. Read/write Single.
Hidden { get; set; }Determines whether the shape is hidden. Read/write Boolean.
HyperlinkClick { get; set; }Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.
HyperlinkManager { get; }Returns the hyperlink manager. Read-only IHyperlinkManager.
HyperlinkMouseOver { get; set; }Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.
IsDecorative { get; set; }Gets or sets ‘Mark as decorative’ option Reed/write Boolean.
IsGrouped { get; }Determines whether the shape is grouped. Read-only Boolean.
IsObjectIcon { get; set; }Determines whether an object is visible as icon. Read/write Boolean.
IsObjectLink { get; }Determines whether an object is linked to external file. Read-only Boolean.
IsTextHolder { get; }Determines whether the shape is TextHolder_PPT. Read-only Boolean.
virtual LineFormat { get; }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.
LinkFileName { get; }Returns the full path to a linked file. Short file name will be used. Read-only String.
LinkPathLong { get; set; }Returns the full path to a linked file. Long file name will be used. Read/write String.
LinkPathRelative { get; }Returns the relative path to a linked file if present, otherwise returns an empty string. Readonly String.
Name { get; set; }Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.
ObjectName { get; set; }Returns or sets the name of an object. Read/write String.
ObjectProgId { get; set; }Returns the ProgID of an object. Read only String.
OfficeInteropShapeId { get; }Gets unique shape identifier in slide scope. Read-only UInt32. See also UniqueId for getting unique shape identifier in presentation scope.
ParentGroup { get; }Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape.
Placeholder { get; }Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder.
Presentation { get; }Returns the parent presentation of a slide. Read-only IPresentation.
RawFrame { get; set; }Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.
Rotation { get; set; }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 Single.
ShapeLock { get; }Returns shape’s locks. Read-only IGraphicalObjectLock. (2 properties)
Slide { get; }Returns the parent slide of a shape. Read-only IBaseSlide.
SubstitutePictureFormat { get; }Returns OleObject image fill properties object. Read-only IPictureFillFormat.
SubstitutePictureTitle { get; set; }Returns or sets the title for OleObject icon. Read/write String.
virtual ThreeDFormat { get; }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.
UniqueId { get; }Gets unique shape identifier in presentation scope. Read-only UInt32. See also OfficeInteropShapeId for getting unique shape identifier in slide scope.
UpdateAutomatic { get; set; }Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read/write Boolean.
Width { get; set; }Returns or sets the width of the shape. Read/write Single.
X { get; set; }Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write Single.
Y { get; set; }Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write Single.
virtual ZOrderPosition { get; }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 Int32.

Methods

NameDescription
AddPlaceholder(IPlaceholder)Adds a new placeholder if there is no and sets placeholder properties to a specified one.
GetBasePlaceholder()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.
GetThumbnail()Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
GetThumbnail(ShapeThumbnailBounds, float, float)Returns shape thumbnail.
RemovePlaceholder()Defines that this shape isn’t a placeholder.
SetEmbeddedData(IOleEmbeddedDataInfo)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.
WriteAsSvg(Stream)Saves content of Shape as SVG file.
WriteAsSvg(Stream, ISVGOptions)Saves content of Shape as SVG file.

Examples

The following example shows how to accessing OLE Object frames.

[C#]
// Loads the PPTX to a presentation object
using (Presentation pres = new Presentation("AccessingOLEObjectFrame.pptx"))
{
    // Accesses the first slide
    ISlide sld = pres.Slides[0];
    // Casts the shape to OleObjectFrame
    OleObjectFrame oleObjectFrame = sld.Shapes[0] as OleObjectFrame;
    // Reads the OLE Object and writes it to disk
    if (oleObjectFrame != null)
    {
        // Gets embedded file data
        byte[] data = oleObjectFrame.EmbeddedData.EmbeddedFileData;
        // Gets embedded file extention
        string fileExtention = oleObjectFrame.EmbeddedData.EmbeddedFileExtension;
        // Creates a path to save the extracted file
        string extractedPath = "excelFromOLE_out" + fileExtention;
        // Saves extracted data
        using (FileStream fstr = new FileStream(extractedPath, FileMode.Create, FileAccess.Write))
        {
            fstr.Write(data, 0, data.Length);
        }
    }
}

See Also