insert_ole_object_as_icon method

insert_ole_object_as_icon(file_name, is_linked, icon_file, icon_caption)

Inserts an embedded or linked OLE object as icon into the document. Allows to specify icon file and caption. Detects OLE object type using file extension.

def insert_ole_object_as_icon(self, file_name: str, is_linked: bool, icon_file: str, icon_caption: str):
    ...
ParameterTypeDescription
file_namestrFull path to the file.
is_linkedboolIf True then linked OLE object is inserted otherwise embedded OLE object is inserted.
icon_filestrFull path to the ICO file. If the value is None, Aspose.Words will use a predefined image.
icon_captionstrIcon caption. If the value is None, Aspose.Words will use the file name.

Returns

Shape node containing Ole object and inserted at the current Builder position.

insert_ole_object_as_icon(file_name, prog_id, is_linked, icon_file, icon_caption)

Inserts an embedded or linked OLE object as icon into the document. Allows to specify icon file and caption. Detects OLE object type using given progID parameter.

def insert_ole_object_as_icon(self, file_name: str, prog_id: str, is_linked: bool, icon_file: str, icon_caption: str):
    ...
ParameterTypeDescription
file_namestrFull path to the file.
prog_idstrProgId of OLE object.
is_linkedboolIf True then linked OLE object is inserted otherwise embedded OLE object is inserted.
icon_filestrFull path to the ICO file. If the value is None, Aspose.Words will use a predefined image.
icon_captionstrIcon caption. If the value is None, Aspose.Words will use the file name.

Returns

Shape node containing Ole object and inserted at the current Builder position.

insert_ole_object_as_icon(stream, prog_id, icon_file, icon_caption)

Inserts an embedded OLE object as icon from a stream into the document. Allows to specify icon file and caption. Detects OLE object type using given progID parameter.

def insert_ole_object_as_icon(self, stream: io.BytesIO, prog_id: str, icon_file: str, icon_caption: str):
    ...
ParameterTypeDescription
streamio.BytesIOStream containing application data.
prog_idstrProgId of OLE object.
icon_filestrFull path to the ICO file. If the value is None, Aspose.Words will use a predefined image.
icon_captionstrIcon caption. If the value is None, Aspose.Words will use the a predefined icon caption.

Returns

Shape node containing Ole object and inserted at the current Builder position.

Examples

Shows how to insert an OLE object into a document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# OLE objects are links to files in our local file system that can be opened by other installed applications.
# Double clicking these shapes will launch the application, and then use it to open the linked object.
# There are three ways of using the "insert_ole_object" method to insert these shapes and configure their appearance.
# 1 -  Image taken from the local file system:
with open(IMAGE_DIR + "Logo.jpg", "rb") as image_stream:

    # If 'presentation' is omitted and 'as_icon' is set, this overloaded method selects
    # the icon according to the file extension and uses the filename for the icon caption.
    builder.insert_ole_object(MY_DIR + "Spreadsheet.xlsx", False, False, image_stream)

# If 'presentation' is omitted and 'as_icon' is set, this overloaded method selects
# the icon according to 'prog_id' and uses the filename for the icon caption.
# 2 -  Icon based on the application that will open the object:
builder.insert_ole_object(MY_DIR + "Spreadsheet.xlsx", "Excel.Sheet", False, True, None)

# If 'icon_file' and 'icon_caption' are omitted, this overloaded method selects
# the icon according to 'prog_id' and uses the predefined icon caption.
# 3 -  Image icon that's 32 x 32 pixels or smaller from the local file system, with a custom caption:
builder.insert_ole_object_as_icon(MY_DIR + "Presentation.pptx", False, IMAGE_DIR + "Logo icon.ico",
    "Double click to view presentation!")

doc.save(ARTIFACTS_DIR + "DocumentBuilder.insert_ole_object.docx")

Shows how to insert an embedded or linked OLE object as icon into the document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# If 'icon_file' and 'icon_caption' are omitted, this overloaded method selects
# the icon according to 'progId' and uses the filename for the icon caption.
builder.insert_ole_object_as_icon(MY_DIR + "Presentation.pptx", "Package", False, IMAGE_DIR + "Logo icon.ico", "My embedded file")

builder.insert_break(aw.BreakType.LINE_BREAK)

with open(MY_DIR + "Presentation.pptx", "rb") as stream:
    # If 'icon_file' and 'icon_caption' are omitted, this overloaded method selects
    # the icon according to the file extension and uses the filename for the icon caption.
    shape = builder.insert_ole_object_as_icon(stream, "PowerPoint.Application", IMAGE_DIR + "Logo icon.ico",
        "My embedded file stream")

    set_ole_package = shape.ole_format.ole_package
    set_ole_package.file_name = "Presentation.pptx"
    set_ole_package.display_name = "Presentation.pptx"

doc.save(ARTIFACTS_DIR + "DocumentBuilder.insert_ole_object_as_icon.docx")

See Also

DocumentBuilder.insert_ole_object method DocumentBuilder.insert_online_video method