ApiSessionCreateDocumentImage Method (ObjectProxy, HierarchyAdjustment, ObjectProxy, String, String) |
Adds a new image section to a document
Namespace:
Articy.Api
Assembly:
ArticyApp (in ArticyApp.dll) Version: 1.0.0
Syntax public ObjectProxy CreateDocumentImage(
ObjectProxy aContextElement,
HierarchyAdjustment aHierarchy,
ObjectProxy aImageAsset = null,
string aText = "",
string aTemplateTechName = null
)
Parameters
- aContextElement
- Type: Articy.ApiObjectProxy
the id of the element to be used as reference for placing the new section - aHierarchy
- Type: Articy.ApiHierarchyAdjustment
determines where the new element should be placed. - aImageAsset (Optional)
- Type: Articy.ApiObjectProxy
the the image asset to use, or null when no image should be referenced for now - aText (Optional)
- Type: SystemString
the description text to be used in front of the image (must be enabled in the show options) - aTemplateTechName (Optional)
- Type: SystemString
a template technical name if the section should get a template null otherwise.
Return Value
Type:
ObjectProxythe newly created (asset-)link section. This method check of the given asset is an image asset and throws an exception if not.
See Also