Click or drag to resize
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
C#
public interface IAttachment : IInfo, 
	IAdvancedDataContainer, IDataContainer, ISimpleDataContainer, ISerializable, ICMSObject, 
	IHierarchicalDataContainer, IHierarchicalObject, INameIndexable, IVirtualHierarchicalObject, IComparable, 
	IRelatedData, IMacroObject

The IAttachment type exposes the following members.

Properties
  NameDescription
Public propertyAllowPartialUpdate
If true, the object allows partial updates.
(Inherited from IInfo.)
Public propertyAttachmentBinary
Gets the binary content of the attachment or attachment version.
Public propertyAttachmentCustomData
Attachment custom data.
Public propertyAttachmentDescription
Gets the description of the attachment or attachment version.
Public propertyAttachmentDocumentID
Related document Document ID.
Public propertyAttachmentExtension
Gets the file name extension of the attachment or attachment version.
Public propertyAttachmentGroupGUID
Holds the GUID of the document field (group) under which the grouped attachment belongs.
Public propertyAttachmentGUID
Gets the globally unique identifier of the attachment or attachment version.
Public propertyAttachmentHash
Gets the string representation of the attachment or attachment version hash.
Public propertyAttachmentImageHeight
Gets the height, in pixels, of the attachment or attachment version.
Public propertyAttachmentImageWidth
Gets the width, in pixels, of the attachment or attachment version.
Public propertyAttachmentIsUnsorted
Indicates if attachment is an unsorted attachment.
Public propertyAttachmentLastModified
Gets the date and time when the attachment or attachment version was last modified.
Public propertyAttachmentMimeType
Gets the MIME type of the attachment or attachment version.
Public propertyAttachmentName
Gets the file name of the attachment or attachment version.
Public propertyAttachmentOrder
Stores the attachment order.
Public propertyAttachmentSearchContent
Extracted content from attachment binary used for search indexing.
Public propertyAttachmentSiteID
Attachment site ID.
Public propertyAttachmentSize
Gets the size, in bytes, of the attachment or attachment version.
Public propertyAttachmentTitle
Gets the title of the attachment or attachment version.
Public propertyAttachmentVariantDefinitionIdentifier
Text identification of used variant definition.
Public propertyAttachmentVariantParentID
Attachment variant parent ID.
Public propertyColumnNames
Column names.
(Inherited from IDataContainer.)
Public propertyGeneralized
Generalized interface of this object.
(Inherited from IInfo.)
Public propertyHasChanged
Returns true if the object changed.
(Inherited from IAdvancedDataContainer.)
Public propertyIsComplete
Returns true if the object is complete (has all columns).
(Inherited from IAdvancedDataContainer.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from ISimpleDataContainer.)
Public propertyObjectSettings
Object settings
(Inherited from IInfo.)
Public propertyProperties
Properties of the object available through GetProperty.
(Inherited from IHierarchicalObject.)
Public propertyRelatedData
Custom data connected to the object.
(Inherited from IRelatedData.)
Public propertyTypeInfo
Object type info
(Inherited from IInfo.)
Top
Methods
  NameDescription
Public methodChangedColumns
Returns list of column names which values were changed.
(Inherited from IAdvancedDataContainer.)
Public methodCloneObject
Creates a clone of the object
(Inherited from IInfo.)
Public methodContainsColumn
Returns true if the object contains specified column.
(Inherited from IDataContainer.)
Public methodDataChanged
Returns true if the object changed.
(Inherited from IAdvancedDataContainer.)
Public methodDelete
Deletes the object using appropriate provider
(Inherited from IInfo.)
Public methodDestroy
Destroys the object including its version history using appropriate provider
(Inherited from IInfo.)
Public methodExecuteWithOriginalData
Executes the given action using original data of the object
(Inherited from IInfo.)
Public methodGetOriginalValue
Returns the original value of column.
(Inherited from IAdvancedDataContainer.)
Public methodGetProperty
Returns property with given name (either object or property value).
(Inherited from IHierarchicalObject.)
Public methodGetValue
Returns value of column.
(Inherited from ISimpleDataContainer.)
Public methodInsert
Inserts the object using appropriate provider
(Inherited from IInfo.)
Public methodItemChanged
Returns true if the item on specified column name changed.
(Inherited from IAdvancedDataContainer.)
Public methodMacroRepresentation
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 methodMakeComplete
Makes the object data complete.
(Inherited from IAdvancedDataContainer.)
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged.
(Inherited from IAdvancedDataContainer.)
Public methodRevertChanges
Reverts the object changes to the original values.
(Inherited from IAdvancedDataContainer.)
Public methodSetValue
Sets value of column.
(Inherited from ISimpleDataContainer.)
Public methodSubmitChanges
Submits the changes in the object to the database.
(Inherited from IInfo.)
Public methodToMacroString
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 methodTryGetProperty(String, Object)
Returns property with given name (either object or property value).
(Inherited from IHierarchicalObject.)
Public methodTryGetProperty(String, Object, Boolean)
Returns property with given name (either object or property value).
(Inherited from IVirtualHierarchicalObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from IDataContainer.)
Public methodUpdate
Updates the database entity using appropriate provider
(Inherited from IInfo.)
Top
Extension Methods
  NameDescription
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodGetPath
Returns relative path for the attachment.
(Defined by IAttachmentExtensions.)
Public Extension MethodIsVariant
Returns true if the attachment is a variant of an original attachment.
(Defined by AttachmentExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, Boolean)Overloaded.
Writes XML representation of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Public Extension MethodToXML(String, Boolean)Overloaded.
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, ListString, Boolean)Overloaded.
Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Top
See Also