IAttachment Interface

Attachment interface to unify access to attachment objects.

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public interface IAttachment : IInfo, 
	IAdvancedDataContainer, IDataContainer, ISimpleDataContainer, ISerializable, ICMSObject, 
	IHierarchicalDataContainer, IHierarchicalObject, INameIndexable, IVirtualHierarchicalObject, IComparable, 
	IRelatedData, IMacroObject

The IAttachment type exposes the following members.

Properties

	Name	Description
Public property	AllowPartialUpdate	If true, the object allows partial updates. (Inherited from IInfo.)
Public property	AttachmentBinary	Gets the binary content of the attachment or attachment version.
Public property	AttachmentCustomData	Attachment custom data.
Public property	AttachmentDescription	Gets the description of the attachment or attachment version.
Public property	AttachmentDocumentID	Related document Document ID.
Public property	AttachmentExtension	Gets the file name extension of the attachment or attachment version.
Public property	AttachmentGroupGUID	Holds the GUID of the document field (group) under which the grouped attachment belongs.
Public property	AttachmentGUID	Gets the globally unique identifier of the attachment or attachment version.
Public property	AttachmentHash	Gets the string representation of the attachment or attachment version hash.
Public property	AttachmentImageHeight	Gets the height, in pixels, of the attachment or attachment version.
Public property	AttachmentImageWidth	Gets the width, in pixels, of the attachment or attachment version.
Public property	AttachmentIsUnsorted	Indicates if attachment is an unsorted attachment.
Public property	AttachmentLastModified	Gets the date and time when the attachment or attachment version was last modified.
Public property	AttachmentMimeType	Gets the MIME type of the attachment or attachment version.
Public property	AttachmentName	Gets the file name of the attachment or attachment version.
Public property	AttachmentOrder	Stores the attachment order.
Public property	AttachmentSearchContent	Extracted content from attachment binary used for search indexing.
Public property	AttachmentSiteID	Attachment site ID.
Public property	AttachmentSize	Gets the size, in bytes, of the attachment or attachment version.
Public property	AttachmentTitle	Gets the title of the attachment or attachment version.
Public property	AttachmentVariantDefinitionIdentifier	Text identification of used variant definition.
Public property	AttachmentVariantParentID	Attachment variant parent ID.
Public property	ColumnNames	Column names. (Inherited from IDataContainer.)
Public property	Generalized	Generalized interface of this object. (Inherited from IInfo.)
Public property	HasChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public property	IsComplete	Returns true if the object is complete (has all columns). (Inherited from IAdvancedDataContainer.)
Public property	Item	Gets or sets the value of the column. (Inherited from ISimpleDataContainer.)
Public property	ObjectSettings	Object settings (Inherited from IInfo.)
Public property	Properties	Properties of the object available through GetProperty. (Inherited from IHierarchicalObject.)
Public property	RelatedData	Custom data connected to the object. (Inherited from IRelatedData.)
Public property	TypeInfo	Object type info (Inherited from IInfo.)

Methods

	Name	Description
Public method	ChangedColumns	Returns list of column names which values were changed. (Inherited from IAdvancedDataContainer.)
Public method	CloneObject	Creates a clone of the object (Inherited from IInfo.)
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from IDataContainer.)
Public method	DataChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public method	Delete	Deletes the object using appropriate provider (Inherited from IInfo.)
Public method	Destroy	Destroys the object including its version history using appropriate provider (Inherited from IInfo.)
Public method	ExecuteWithOriginalData	Executes the given action using original data of the object (Inherited from IInfo.)
Public method	GetOriginalValue	Returns the original value of column. (Inherited from IAdvancedDataContainer.)
Public method	GetProperty	Returns property with given name (either object or property value). (Inherited from IHierarchicalObject.)
Public method	GetValue	Returns value of column. (Inherited from ISimpleDataContainer.)
Public method	Insert	Inserts the object using appropriate provider (Inherited from IInfo.)
Public method	ItemChanged	Returns true if the item on specified column name changed. (Inherited from IAdvancedDataContainer.)
Public method	MacroRepresentation	Returns the object which represents current object in the macro engine. Whenever the object implementing IMacroObject interface is used within macro engine this method is called its result is used instead. (Inherited from IMacroObject.)
Public method	MakeComplete	Makes the object data complete. (Inherited from IAdvancedDataContainer.)
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged. (Inherited from IAdvancedDataContainer.)
Public method	RevertChanges	Reverts the object changes to the original values. (Inherited from IAdvancedDataContainer.)
Public method	SetValue	Sets value of column. (Inherited from ISimpleDataContainer.)
Public method	SubmitChanges	Submits the changes in the object to the database. (Inherited from IInfo.)
Public method	ToMacroString	Returns the default text representation in the macros (this is called when the expression is resolved to its final value and should be converted to string). (Inherited from IMacroObject.)
Public method	TryGetProperty(String, Object)	Returns property with given name (either object or property value). (Inherited from IHierarchicalObject.)
Public method	TryGetProperty(String, Object, Boolean)	Returns property with given name (either object or property value). (Inherited from IVirtualHierarchicalObject.)
Public method	TryGetValue	Returns value of column. (Inherited from IDataContainer.)
Public method	Update	Updates the database entity using appropriate provider (Inherited from IInfo.)

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	GetPath	Returns relative path for the attachment. (Defined by IAttachmentExtensions.)
Public Extension Method	IsVariant	Returns true if the attachment is a variant of an original attachment. (Defined by AttachmentExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)