articy:draft 3 Macro DevKit Reference
Starter Guide
Articy.Api
ApiConsts Class
ApiLocationTools Class
ApiMode Enumeration
ApiSession Class
ApiSession.FocusPane Enumeration
ApiSession.FocusTab Enumeration
ApiSession.FocusWindow Enumeration
ArticyApiException Class
CloseProgressMode Enumeration
CloseProjectArgs Class
ComplexApiCallArgs Class
ContextMenuContext Enumeration
EntryType Enumeration
ErrorCode Enumeration
ExportDataArgs Class
ExportDocumentToDocxArgs Class
ExportObjectSelectionDataArgs Class
ExportTextFormat Enumeration
ExportToAccessArgs Class
ExportToDocxArgs Class
ExportToFullXmlArgs Class
ExportToXlsxArgs Class
ExportXlsxForReimportArgs Class
ExportXlsxForReimportArgs.SortObjectsBy Enumeration
FlowListNode Class
FlowReference Class
FlowReference.RefType Enumeration
GenericExportDataArgs Class
HierarchyAdjustment Enumeration
IsObjectAllowed Delegate
JourneyActionTypes Enumeration
JsonExportArgs Class
LoggingCallback Delegate
ObjectContext Enumeration
ObjectPropertyInfo Class
ObjectPropertyNames Class
ObjectProxy Class
ObjectProxy Properties
ObjectProxy Methods
AddAttachmentToStrip Method
AddInputPin Method
AddOutputPin Method
ClearStrip Method
FindIndex Method
GetAllowedChildrenTypes Method
GetAttachments Method
GetAvailableProperties Method
GetChildren Method
GetColor Method
GetColumnIndex Method
GetDataType Method
GetDisplayName Method
GetExternalId Method
GetFlowPosition Method
GetFlowSize Method
GetInputPin Method
GetInputPins Method
GetObjectContext Method
GetObjectUrl Method
GetOutputPin Method
GetOutputPins Method
GetParent Method
GetPartitionId Method
GetPreviewImage Method
GetPropertyInfo Method
GetShortId Method
GetStripElements Method
GetStripIds Method
GetStripMap Method
GetTechnicalName Method
GetTemplateId Method
GetTemplateTechnicalName Method
GetText Method
HasProperty Method
InsertAttachmentIntoStrip Method
IsInContext Method
IsInDocumentContext Method
IsInFlowContext Method
IsInLocationContext Method
IsValidExpressoScript Method
MayAddAttachmentToStrip Method
MayInsertAttachmentIntoStrip Method
MaySetObjectReference Method
RemoveAttachmentFromStrip Method
RemoveAttachmentFromStripAtIndex Method
RemoveInputPin Method
RemoveOutputPin Method
RunQuery Method
SetColor Method
SetDisplayName Method
SetExternalId Method
SetFlowPosition Method
SetFlowSize Method
SetPreviewImage Method
SetShortId Method
SetTechnicalName Method
SetTemplate Method
SetText Method
ValidateExpressoScript Method
ObjectType Enumeration
OpenProjectArgs Class
ProjectRightLevel Enumeration
ProjectUnavailabilityReason Enumeration
PropertyDataSubType Enumeration
PropertyDataType Enumeration
PropertyFilter Enumeration
RepartitionMode Enumeration
ResultSet Class
RuleSetBasedExport Class
SearchConflictsIn Enumeration
SearchTextIn Enumeration
SelectionContext Enumeration
SimplePartitionActionArgs Class
SystemFolderNames Enumeration
TextFilterRelation Enumeration
TextFormat Enumeration
Transformer Class
Transformer.AnchorPosition Enumeration
Transformer.TransformMode Enumeration
UnclaimPartitionArgs Class
Unity3DExportArgs Class
Unreal4ExportArgs Class
WaitForAssetProcessingArgs Class
Articy.Api.Data
Articy.Api.Plugins
Articy.Export.Office
Click or drag to resize

ObjectProxyGetPreviewImage Method

Returns the asset that is set as preview image for this object.

Namespace:  Articy.Api
Assembly:  QueryLayer (in QueryLayer.dll) Version: 1.0.0
Syntax
C#
Copy
public ObjectProxy GetPreviewImage()

Return Value

Type: ObjectProxy
the asset object, that serves as preview image for this object
Exceptions
ExceptionCondition
ArticyApiExceptionIf the object does not have a PreviewImage property, error code ErrorCode.PropertyNotFound is thrown.
See Also