TreeNode Methods |
The TreeNode type exposes the following members.
Name | Description | |
---|---|---|
AddColumnPrefixesWhereCondition |
Adds restriction to given where filtering out all rows where given column starts with one of excluded prefixes found in TypeInfo default data settings.
(Inherited from BaseInfo.) | |
AllowExternalColumn |
Indicates whether a given column is allowed to be saved externally.
(Inherited from AbstractInfoBaseTInfo.) | |
AnyItemChanged |
Returns true if any of specified columns changed.
(Inherited from AbstractInfoBaseTInfo.) | |
Archive |
Archives the document.
| |
BuildObjectPath |
Builds the path from the given column.
(Inherited from BaseInfo.) | |
ChangedColumns |
Returns collection of column names which values were changed.
(Inherited from AbstractCompositeInfoTInfo.) | |
ChangeNodeDocumentType |
Ensures changing the underlying database structure of a given document to its document type.
Changes only the published data of the document type (CMS_Document and coupled data). Fills missing values with the data from given document node.
| |
CheckDefaultPermissions |
Check universal permissions for an object
(Inherited from BaseInfo.) | |
CheckDependencies |
Checks object for dependent objects. Returns true if there is at least one dependent object.
First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfo.) | |
CheckIn |
Checks the document in.
| |
CheckLicense |
Checks the object license. Returns true if the licensing conditions for this object were matched.
(Inherited from BaseInfo.) | |
CheckOut |
Checks the document out.
| |
CheckPermissions |
Checks whether the specified user has permissions for this object.
(Inherited from BaseInfo.) | |
CheckPermissionsInternal |
Checks the permissions of the object.
(Overrides BaseInfoCheckPermissionsInternal(PermissionsEnum, String, IUserInfo, Boolean).) | |
CheckPermissionsWithHandler |
Checks the permissions of the object.
(Overrides BaseInfoCheckPermissionsWithHandler(PermissionsEnum, String, IUserInfo, Boolean).) | |
CheckUniqueCodeName |
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from BaseInfo.) | |
CheckUniqueValues |
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
(Inherited from BaseInfo.) | |
ClearCache |
Clears the document cache.
| |
ClearCache(String) |
Clears the document cache.
| |
ClearCachedValues |
Clears the cached values depending on the given column value.
(Inherited from BaseInfo.) | |
ClearData |
Clears data from the object.
(Inherited from BaseInfo.) | |
ClearOutputCache(Boolean) |
Clears the output cache for current page.
| |
ClearOutputCache(Boolean, Boolean) |
Clears the output cache for current page.
| |
Clone(Boolean) |
Creates a clone of the object.
(Inherited from AbstractCompositeInfoTInfo.) | |
CloneNewNodeType |
Returns a clone of the node.
| |
CloneObject |
Creates the clone of the object
(Inherited from AbstractInfoBaseTInfo.) | |
ColumnsChanged |
Returns true if at least one column of the column list provided as the first argument was changed.
(Inherited from AbstractInfoBaseTInfo.) | |
CombineColumnNames(ICollection) |
Combines column names from supplied collections into a list and caches it in mCombinedColumnNames.
Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true.
Returns combined column names.
(Inherited from AbstractInfoBaseTInfo.) | |
CombineColumnNames(String) |
Combines supplied column names into a list and caches it in mCombinedColumnNames.
Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true.
Returns combined column names.
(Inherited from AbstractInfoBaseTInfo.) | |
CompareTo |
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from BaseInfo.) | |
ContainsColumn |
Returns true if the object contains specific column.
(Overrides AbstractCompositeInfoTInfoContainsColumn(String).) | |
CopyDataTo |
Copies the node data to the destination node according to the settings.
| |
CopyExternalColumns |
Copy value of external columns directly via set value
(Inherited from BaseInfo.) | |
CopyMemoryProperties |
Copies memory properties
(Inherited from BaseInfo.) | |
CopyProperties |
Copies memory properties
(Inherited from AbstractInfoBaseTInfo.) | |
CreateNewVersion |
Creates new document version. (Moves document to edit step.)
| |
DataChanged |
Returns true if the object has changed.
| |
DataChanged(String) |
Indicates whether object was changed.
(Inherited from AbstractCompositeInfoTInfo.) | |
Delete |
Deletes the document to the recycle bin. Deletes only this culture version of the document to the recycle bin, including the bound product.
(Overrides BaseInfoDelete.) | |
Delete(Boolean) |
Deletes the document to the recycle bin. Deletes only this culture version of the document to the recycle bin, including the bound product.
| |
Delete(Boolean, Boolean) |
Deletes the document.
| |
DeleteAllCultures |
Deletes all the culture versions of the specified node including the child nodes.
| |
DeleteChildNodes |
Deletes the child nodes of all culture versions under the specified parent node.
| |
DeleteData |
Deletes the object.
(Inherited from AbstractInfoBaseTInfo.) | |
DeleteDataInternal |
Deletes the object data from the database.
(Inherited from AbstractCompositeInfoTInfo.) | |
DeleteExternalColumns |
Goes through the columns which are stored externally and deletes all the files.
(Inherited from AbstractInfoBaseTInfo.) | |
DeleteMetafiles |
Deletes the metafiles related to this object
(Inherited from AbstractInfoBaseTInfo.) | |
DeleteObject |
Deletes the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoDeleteObject.) | |
Destroy |
Destroys the document with its version history. Destroys only this culture version of the document.
(Overrides BaseInfoDestroy.) | |
Disconnect |
Disconnects the collection from the database.
(Inherited from BaseInfo.) | |
Dispose |
Disposes the object.
| |
EnsureBinaryData |
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
(Inherited from BaseInfo.) | |
EnsureBinaryData(Boolean) |
Makes sure that the binary data is loaded into binary column of the object.
(Inherited from BaseInfo.) | |
EnsureCodeName |
Ensures the code name of the object if not set
(Inherited from BaseInfo.) | |
EnsureConsistency |
Ensures data consistency.
| |
EnsureData |
Creates a new data class container within the object
(Inherited from AbstractInfoBaseTInfo.) | |
EnsureDefaultValues |
Sets the document default values.
| |
EnsureGUID |
Ensures the GUID of the object
(Inherited from BaseInfo.) | |
EnsureHierarchyColumns |
Ensures the IDPath and Level columns.
(Inherited from BaseInfo.) | |
EnsureLastModified |
Ensures the last modified time stamp of the object
(Inherited from BaseInfo.) | |
EnsureUniqueCodeName |
Ensures that the object has a unique code name within it's context
(Inherited from BaseInfo.) | |
ExecuteWithOriginalData |
Executes the given action using original data of the object.
(Inherited from AbstractCompositeInfoTInfo.) | |
ExportDefaultData |
Exports the default object installation data
(Inherited from BaseInfo.) | |
Finalize |
Destructor
(Inherited from BaseInfo.) | |
GetAutomaticCodeName |
Gets the automatic code name for the object
(Inherited from BaseInfo.) | |
GetAutomaticProperty |
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.) | |
GetBinaryData |
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
(Inherited from BaseInfo.) | |
GetBooleanValue |
Gets the boolean value from the object.
(Inherited from BaseInfo.) | |
GetCacheDependencies |
Gets collection of dependency keys to be touched when modifying the current object.
(Inherited from BaseInfo.) | |
GetChildDependencies |
Gets the child dependencies repository
(Inherited from BaseInfo.) | |
GetChildWhereCondition |
Gets the child object where condition.
(Overrides BaseInfoGetChildWhereCondition(WhereCondition, String).) | |
GetColumnNames |
Gets the default list of column names for this class
(Inherited from AbstractInfoBaseTInfo.) | |
GetComponents |
Gets the list of internal components
(Overrides AbstractCompositeInfoTInfoGetComponents.) | |
GetCount |
Gets count of the objects filtered by given where condition.
(Inherited from BaseInfo.) | |
GetCurrentObjectPathPart |
Builds the path from the given column.
(Inherited from BaseInfo.) | |
GetCustomProperties |
Gets list of custom properties.
(Inherited from BaseInfo.) | |
GetData |
Returns the data according to the set of input parameters.
(Inherited from BaseInfo.) | |
GetDataQueryInternal |
Gets the data query for this object type
(Overrides BaseInfoGetDataQueryInternal.) | |
GetDataSet |
Returns the DataSet of the node data.
| |
GetDateTimeValue |
Gets the DateTime value from the object.
(Inherited from BaseInfo.) | |
GetDecimalValue |
Gets the decimal value from the object.
(Inherited from BaseInfo.) | |
GetDefaultData |
Returns the default object installation data
(Inherited from BaseInfo.) | |
GetDefaultDataExportColumns |
Returns names of all columns that should be exported with default data as a comma separated string.
(Inherited from BaseInfo.) | |
GetDefaultDataWhereCondition |
Gets the where condition to filter out the default installation data
(Inherited from BaseInfo.) | |
GetDefaultObject |
Returns default object of given object type. Has to be overridden in specific info. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
(Inherited from BaseInfo.) | |
GetDependenciesNames |
Returns a list of object names which depend on this object.
First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfo.) | |
GetDependenciesNamesAuto |
Returns a list of object names which depend on this object.
(Inherited from BaseInfo.) | |
GetDependencyObjectType |
Gets dependency object type
(Inherited from BaseInfo.) | |
GetDocumentName |
Returns friendly document name.
| |
GetDoubleValue |
Gets the double value from the object.
(Inherited from BaseInfo.) | |
GetEditingPageURL |
Gets the object editing page URL.
(Inherited from BaseInfo.) | |
GetExisting |
Returns the existing object based on current object data.
(Overrides BaseInfoGetExisting.) | |
GetExistingBase |
Returns single info object and ensures correct GUID vs. code name priority is used (if applicable) after resolving provided whereCondition.
(Inherited from BaseInfo.)If no object match provided whereCondition, null is returned. | |
GetExistingWhereCondition |
Gets a where condition to find an existing object based on current object
(Overrides BaseInfoGetExistingWhereCondition.) | |
GetExistingWhereCondition(Boolean) |
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.) | |
GetExternalColumnData |
Returns the column data from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.) | |
GetExternalColumns |
Returns the list of columns registered as the external columns.
(Inherited from AbstractInfoBaseTInfo.) | |
GetExternalColumnSettings |
Returns settings for external storage of the column. Returns null by default (which causes the default settings to be used in the external column data storage process).
(Inherited from AbstractInfoBaseTInfo.) | |
GetExternalFiles |
Goes through the columns which are stored externally and returns the list of particular files this object uses.
(Inherited from AbstractInfoBaseTInfo.) | |
GetExternalPath |
Returns path to the external storage with data of the given column. If the column data is not stored in the external storage (not enabled), and the check for enabled is allowed, returns null.
(Inherited from AbstractInfoBaseTInfo.) | |
GetFieldAttachment | Obsolete.
Retrieves the attachment associated with the specified field of type File.
| |
GetFieldAttachments | Obsolete.
Retrieves an enumerable collection of attachments associated with the specified field of type Attachments.
| |
GetFieldDocumentAttachment |
Retrieves the attachment associated with the specified field of type File.
| |
GetFieldDocumentAttachments |
Retrieves an enumerable collection of attachments associated with the specified field of type Attachments.
| |
GetFileInfo |
Returns FileInfo object from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.) | |
GetFullObjectName |
Returns the name of the object within its parent hierarchy.
(Overrides BaseInfoGetFullObjectName(Boolean, Boolean, Boolean).) | |
GetGeneralizedInfo |
Gets the generalized info for this object
(Inherited from AbstractInfoBaseTInfo.) | |
GetGlobalPermissionName |
Returns name of the global permission name corresponding to the given permission name.
By default, "Global" + permissionName is returned.
(Inherited from BaseInfo.) | |
GetGroupWhereCondition |
Gets the group where condition for the object
(Inherited from BaseInfo.) | |
GetGuidValue |
Gets the guid value from the object.
(Inherited from BaseInfo.) | |
GetIconUrl |
Gets the object icon URL
(Inherited from BaseInfo.) | |
GetIDPathPartLength |
Returns the length of a part of IDPath.
(Inherited from BaseInfo.) | |
GetInheritedValue |
Returns the inherited value for the document.
| |
GetIntegerValue |
Gets the integer value from the object.
(Inherited from BaseInfo.) | |
GetLastObjectOrder |
Returns number which will be the last order within all the other items (according to Parent, Group and Site settings).
I.e. returns largest existing order + 1.
(Inherited from BaseInfo.) | |
GetLocalColumnNames |
Gets the list of local column names for particular object.
(Overrides AbstractInfoBaseTInfoGetLocalColumnNames.) | |
GetLocalProperties |
Gets the list of local properties for particular object
(Inherited from AbstractInfoBaseTInfo.) | |
GetLockObject |
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
(Inherited from BaseInfo.) | |
GetModifiedFrom |
Gets the DataSet of all the objects modified from specified date.
(Inherited from BaseInfo.) | |
GetNameCollisions |
Gets the list of the name collisions of the given object
(Inherited from BaseInfo.) | |
GetNamePathPartColumn |
Returns the name of the column which is used to build the NamePath
(Inherited from BaseInfo.) | |
GetObject(Int32) |
Gets the object by its ID.
(Inherited from BaseInfo.) | |
GetObject(IWhereCondition, Boolean) |
Gets the object by specified where condition.
(Inherited from BaseInfo.) | |
GetObjectChildren |
Gets the object children repository
(Inherited from BaseInfo.) | |
GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from AbstractCompositeInfoTInfo.) | |
GetObjectIdentifier |
Gets the object identifier that uniquely identifies the object
(Inherited from BaseInfo.) | |
GetObjectKey |
Gets the unique string key for the object.
(Overrides BaseInfoGetObjectKey.) | |
GetObjectName |
Returns object name combining object type name and object display name.
(Overrides BaseInfoGetObjectName.) | |
GetObjectOrderID |
Returns ID of the item being ordered (i.e. NodeID).
(Overrides BaseInfoGetObjectOrderID.) | |
GetObjectTypeForColumn |
Gets the object type for the given column or null if the object type is not found or unknown.
(Inherited from BaseInfo.) | |
GetOrderIdentityWhereCondition |
Gets order identity where condition to identify the correct node data which are currently ordered
(Overrides BaseInfoGetOrderIdentityWhereCondition.) | |
GetOrderQueryParameters |
Creates QueryDataParameters with special macros for object order management.
(Overrides BaseInfoGetOrderQueryParameters(String, String, Boolean).) | |
GetOriginalDataSet |
Returns the DataSet of node data. For linked documents data of original document is included.
| |
GetOriginalValue |
Returns the original value of given column.
(Inherited from AbstractCompositeInfoTInfo.) | |
GetOtherBindings |
Gets the repository of other bindings
(Inherited from BaseInfo.) | |
GetParent |
Returns the parent object.
(Inherited from BaseInfo.) | |
GetPermissionName |
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called.
Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
(Inherited from BaseInfo.) | |
GetPermissionObjectType |
Returns the permission object type of the object (checks the SiteID column and SiteBinding columns). According to this value, the permission check is performed.
(Inherited from BaseInfo.) | |
GetPermissionToCheck |
Gets permission to check for the object. By default the Create and Delete permission
is changed to Modify.
(Inherited from BaseInfo.) | |
GetPhysicalFiles |
Gets DataSet with physical files.
(Inherited from BaseInfo.) | |
GetPreviewLink |
Returns document preview link.
| |
GetProperty |
Gets the property value.
(Inherited from BaseInfo.) | |
GetPropertyType |
Returns the type of given property.
(Overrides AbstractCompositeInfoTInfoGetPropertyType(String).) | |
GetReferencedObject |
Obtains the object to which the particular column refers.
| |
GetReferringObjects |
Gets the repository of depending objects
(Inherited from BaseInfo.) | |
GetRegisteredProperties |
Gets list of registered properties.
(Inherited from AbstractInfoBaseTInfo.) | |
GetRelatedDocuments |
Retrieves a query that selects documents related to the current document with the relationship name given by specified field.
Selects only documents of the same culture as the parent node.
| |
GetSearchDocument |
Returns document with dependence on current object type and index.
(Overrides AbstractInfoBaseTInfoGetSearchDocument(ISearchIndexInfo).) | |
GetSearchFields |
Returns search fields collection. When existing collection is passed as argument, fields will be added to that collection.
When collection is not passed, new collection will be created and return.
Collection will contain field values only when collection with StoreValues property set to true is passed to the method.
When method creates new collection, it is created with StoreValues property set to false.
(Overrides AbstractInfoBaseTInfoGetSearchFields(ISearchIndexInfo, ISearchFields).) | |
GetSearchID |
Returns an unique id of current object for search index (documentid;nodeid).
(Overrides BaseInfoGetSearchID.) | |
GetSearchImageUrl |
Returns URL for a search result item image.
(Inherited from AbstractInfoBaseTInfo.) | |
GetSiblingsQueryInternal |
Gets the parametrized query to get siblings of the document. Uses best matching culture and filters out all culture versions of the current document.
(Overrides BaseInfoGetSiblingsQueryInternal(ActionDataQuerySettings).) | |
GetSiblingsWhereCondition |
Creates where condition according to Parent, Group and Site settings.
(Overrides BaseInfoGetSiblingsWhereCondition.) | |
GetSiteWhereCondition |
Gets the site where condition for the object
(Inherited from BaseInfo.) | |
GetStringValue |
Gets the string value from the object.
(Inherited from BaseInfo.) | |
GetSynchronizedColumns |
Gets the list of synchronized columns for this object.
(Inherited from BaseInfo.) | |
GetThumbnailUrl |
Gets the object thumbnail URL
(Inherited from BaseInfo.) | |
GetTranslatedCultures |
Gets list of culture codes to which is the document translated to.
| |
GetTypeSpecificColumnNames |
Gets the column names that are specific to the type
| |
GetUniqueCodeName |
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.) | |
GetUniqueDisplayName |
Returns the unique display name for the specified object.
(Inherited from BaseInfo.) | |
GetUniqueName |
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.) | |
GetUniqueNameWhereCondition |
Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
(Inherited from BaseInfo.) | |
GetUpperTree |
Returns the upper tree data for given document.
| |
GetUsedPageTemplateId |
Gets the page template id used by this document.
| |
GetUsedPageTemplateIdColumn |
Gets the page template id used by this document.
| |
GetValue(String) |
Gets the field value.
(Inherited from AbstractInfoBaseTInfo.) | |
GetValueT(String, T) |
Gets the field value converted to a specified type.
(Inherited from AbstractInfoBaseTInfo.) | |
GetValueForTranslation |
Returns value for translation services. Returns unmodified field content by default.
(Inherited from BaseInfo.) | |
GetVirtualFileRelativePath |
Returns virtual relative path for specific column
Ensures the GUID of the object
(Inherited from BaseInfo.) | |
GetWorkflow |
Gets node current workflow (depends on document current workflow step or if document is under a workflow scope).
| |
Initialize(String, IDataContainer, TreeProvider) |
Initializes the object created with default constructor. Use it to load existing node from data row.
| |
Initialize(String, DataRow, TreeProvider) |
Initializes the object created with default constructor. Use it to load existing node from data row.
| |
InitObjectsOrder |
Inits the proper order of the sibling objects so the order column is consistent.
(Inherited from BaseInfo.) | |
InitObjectsOrderPostprocessing |
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization. Does nothing by default.
(Overrides BaseInfoInitObjectsOrderPostprocessing.) | |
Insert |
Hides the insert method without parameter. Do not use!
(Overrides BaseInfoInsert.) | |
Insert(TreeNode, Boolean) |
Inserts current node under specified parent node.
| |
InsertAsClone |
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
(Inherited from BaseInfo.) | |
InsertAsCloneInternal |
This method is called on cloned object prepared in memory by InsertAsClone method.
Override if you need to do further actions before inserting actual object to DB (insert special objects, modify foreign keys, copy files, etc.).
Calls Insert() by default.
(Inherited from BaseInfo.) | |
InsertAsClonePostprocessing |
This method is called once the object is completely cloned (with all children, bindings, etc.).
Override if you need to do further actions after the object has been cloned.
(Inherited from BaseInfo.) | |
InsertAsLink |
Inserts current node under specified parent node as a document link.
| |
InsertAsLinkInternal |
Inserts current node under specified parent node as a document link.
| |
InsertAsNewCultureVersion |
Inserts current node as new culture version of the same document.
| |
InsertAsNewCultureVersionInternal |
Inserts current node as a new culture version of the specified document.
| |
InsertCultureData |
Inserts the CMS_Document part of the document node.
| |
InsertData |
Inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.) | |
InsertDataInternal |
Inserts the object data to the database.
(Inherited from AbstractCompositeInfoTInfo.) | |
InsertInternal |
Inserts current node under specified parent node. The node is inserted as root if its class is root class.
| |
InsertTreeNodeData |
Inserts the CMS_Tree part of the document node.
| |
Invalidate |
Invalidates the object in the object table.
(Inherited from BaseInfo.) | |
IsAvailableOnSite |
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
(Inherited from BaseInfo.) | |
IsCheckedOutByUser |
Returns true if the object is checked out by the specified user.
(Inherited from BaseInfo.) | |
IsChildOf |
Returns true if the object is child of the given object. If parameter parent is null, returns true only if the object is not a child of any object.
(Inherited from BaseInfo.) | |
IsModifiedExternally |
Goes through the columns which are stored externally and checks if the data in DB is the same as in external storage. If all the columns are same returns true, otherwise false.
(Inherited from AbstractInfoBaseTInfo.) | |
IsObjectInvalid |
Returns true if the object is invalid.
(Inherited from BaseInfo.) | |
IsProduct |
Returns true if the document represents a product.
| |
IsProductSection |
Returns true if the document type stands for the product section.
| |
IsRootNode |
Returns true if the document is a root node.
| |
IsTranslated |
Indicates if document is translated to the given culture.
| |
ItemChanged |
Returns true if the item on specified column name changed.
(Inherited from AbstractCompositeInfoTInfo.) | |
LoadComponentsData |
Loads internal components from the given data source
(Overrides AbstractCompositeInfoTInfoLoadComponentsData(IDataContainer).) | |
LoadData |
Loads the object data from given data container.
(Overrides AbstractCompositeInfoTInfoLoadData(LoadDataSettings).) | |
LoadDefaultData |
Sets the object default values.
(Inherited from AbstractCompositeInfoTInfo.) | |
LoadInheritedValues |
Loads the inherited values to the node.
| |
MacroRepresentation |
By default, BaseInfo has no special macro representation.
(Inherited from BaseInfo.) | |
MakeComplete |
Makes the object data complete.
(Overrides AbstractCompositeInfoTInfoMakeComplete(Boolean).) | |
MapDocumentName |
Maps the document name based on the document type settings.
| |
MoveToFirstStep |
Moves the document to first step in the workflow (removes the workflow information if document is not under a workflow anymore).
| |
MoveToNextStep |
Moves the document to a next step in the workflow (sends the document to approval, approves or publishes the document based on the current workflow status).
| |
MoveToPreviousStep |
Moves the document to a previous step in the workflow (rejects the document).
| |
MoveToPublishedStep |
Moves the document directly to published workflow step (moves document directly to publish step, skips all following steps).
| |
New |
Creates new instance of an empty un-typed TreeNode.
| |
New(DataRow) |
Creates new instance of given class which must inherit TreeNode and fill it with given data.
| |
New(String, TreeProvider) |
Creates new instance of given class which must inherit TreeNode.
| |
New(String, DataRow, TreeProvider) |
Creates new instance of given class which must inherit TreeNode and fill it with given data.
| |
NewNodeType(DataRow) |
Creates new instance of given class which must inherit specified node type and fill it with given data.
| |
NewNodeType(String) |
Creates new instance of given class which must inherit specified node type and fill it with given data.
| |
NewNodeType(String, IDataContainer, TreeProvider) |
Creates new instance of given class which must inherit specified node type and fill it with given data.
| |
NewNodeType(String, DataRow, TreeProvider) |
Creates new instance of given class which must inherit specified node type and fill it with given data.
| |
NewObject |
Creates a new object from the given DataRow
(Overrides BaseInfoNewObject(LoadDataSettings).) | |
PermissionCheckException |
Fires an exception in case authorization result is false (denied or insignificant)
(Inherited from BaseInfo.) | |
PropertyPropertyType |
Returns the extension property for the object
(Inherited from AbstractObject.) | |
Publish |
Publishes the document (moves document to publish step through all following steps). If there is not only one path to published step, document stays in the last step it reached.
| |
Reconnect |
Reconnects the collection to the database.
(Inherited from BaseInfo.) | |
RegisterExternalColumn |
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.) | |
RegisterExternalColumns |
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.) | |
RegisterGroupedAttachments |
Registers the grouped attachments for this document.
| |
RegisterProperties |
Registers properties of this object.
(Overrides AbstractInfoBaseTInfoRegisterProperties.) | |
RegisterProperty(String, Object, FuncTInfo, Object, Object) |
Registers the given parametrized property to the object.
(Inherited from AbstractInfoBaseTInfo.) | |
RegisterPropertyTProperty(String, FuncTInfo, Object) |
Registers the given property to the object
(Inherited from AbstractInfoBaseTInfo.) | |
RemoveDocumentDependencies |
Removes document dependencies.
| |
RemoveObjectDependencies |
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
(Inherited from BaseInfo.) | |
ResetChanges |
Resets the object changes and keeps the new values as unchanged.
(Overrides AbstractCompositeInfoTInfoResetChanges.) | |
ResetTranslationFlag |
Clears 'Document is waiting for translation' flag.
| |
RestoreSettings |
Restores local settings for object instance.
(Inherited from BaseInfo.) | |
RevertChanges |
Reverts the object changes and keeps the original values.
(Inherited from AbstractCompositeInfoTInfo.) | |
SaveExternalColumns |
Goes through the columns which are stored externally and ensures them in the external storage.
(Inherited from AbstractInfoBaseTInfo.) | |
SendNotifications |
Raises the notifications events and sends the notifications.
| |
SerializationNotSupported |
Throws serialization not supported exception
(Inherited from BaseInfo.) | |
SetComponents |
Sets the list of internal components
(Overrides AbstractCompositeInfoTInfoSetComponents(IEnumerableIInfo).) | |
SetData |
Updates or inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.) | |
SetDataRowColumn |
Sets the value for the column in the DataRow.
| |
SetDefaultPageTemplateID |
Sets the default document page template ID.
| |
SetDocumentNameSource(String) |
Sets the document name source field to the given value.
| |
SetDocumentNameSource(String, Boolean) |
Sets the document name source field to the given value.
| |
SetExternalColumnData |
Saves the column data to the external storage if exists.
Returns true if data was stored in external storage and should not be stored also in DB.
If data should be stored in DB, returns false.
(Inherited from AbstractInfoBaseTInfo.) | |
SetIntegerValue |
Sets the integer value of the Tree node.
| |
SetObject |
Updates the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoSetObject.) | |
SetObjectAlphabeticalOrder |
Moves the object to the right position according to the custom order.
(Inherited from BaseInfo.) | |
SetObjectOrder |
Moves the object to the specified order. The move is done within the object's siblings.
(Inherited from BaseInfo.) | |
SetObjectOrderPostprocessing |
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
(Overrides AbstractInfoBaseTInfoSetObjectOrderPostprocessing.) | |
SetParent |
Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
(Inherited from BaseInfo.) | |
SetReadOnly |
Locks the object as a read-only
(Inherited from AbstractInfoBaseTInfo.) | |
SetValue(String, Object) |
Sets value of the specified node column.
(Overrides AbstractCompositeInfoTInfoSetValue(String, Object).) | |
SetValue(String, Object, Boolean) |
Sets the object value to the nullable column.
(Inherited from BaseInfo.) | |
SetValue(String, Object, Object) |
Sets the object value to the nullable column.
(Inherited from BaseInfo.) | |
SortAlphabetically |
Sort objects alphabetically.
(Inherited from BaseInfo.) | |
StoreSettings |
Stores local settings for object instance.
(Inherited from BaseInfo.) | |
SubmitChanges(Boolean) |
Submits the changes in the object to the database.
(Overrides BaseInfoSubmitChanges(Boolean).) | |
SubmitChanges(Boolean, TreeNode) |
Submits the changes in the object to the database.
| |
ToMacroString |
Returns the default text representation in the macros.
(Inherited from BaseInfo.) | |
ToString |
Returns the text representation of the object
(Inherited from BaseInfo.) | |
TouchKeys |
Touches the cache dependency keys of the object to flush the dependent cache items.
(Inherited from AbstractInfoBaseTInfo.) | |
TouchParent |
Updates the parent object by saving it (to update the timestamp).
(Inherited from BaseInfo.) | |
TryGetAutomaticProperty |
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.) | |
TryGetProperty(String, Object) |
Obtains value of specified property.
(Overrides AbstractInfoBaseTInfoTryGetProperty(String, Object).) | |
TryGetProperty(String, Object, Boolean) |
Returns value of property.
(Inherited from BaseInfo.) | |
TryGetValue |
Obtains value of given column.
(Overrides AbstractCompositeInfoTInfoTryGetValue(String, Object).) | |
UndoCheckOut |
Rolls the checkout operation of the document back.
| |
Update |
Updates node data in the database.
(Overrides BaseInfoUpdate.) | |
Update(Boolean) |
Updates node data in the database.
| |
UpdateCoupledData |
Updates the coupled data of the document node.
| |
UpdateCultureData |
Updates the CMS_Document part of the document node.
| |
UpdateData |
Updates the object to the database.
(Inherited from AbstractInfoBaseTInfo.) | |
UpdateDataInternal |
Updates the object data to the database.
(Inherited from AbstractCompositeInfoTInfo.) | |
UpdateDocumentContent |
Updates the content of the document.
| |
UpdateExternalColumns |
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
(Inherited from AbstractInfoBaseTInfo.) | |
UpdateFromDB |
Updates the data of the object from DB (updates also ObjectSettings).
(Inherited from BaseInfo.) | |
UpdateInternal |
Updates node data in the database.
| |
UpdatePhysicalFiles |
Saves physical files.
(Inherited from BaseInfo.) | |
UpdateTreeNodeData |
Updates the CMS_Tree part of the document node.
| |
UpsertData |
Updates or inserts the object to the database.
(Inherited from AbstractCompositeInfoTInfo.) | |
UpsertDataInternal |
Upserts the data to the database.
(Inherited from AbstractCompositeInfoTInfo.) | |
WriteDefaultData |
Writes the default object installation data into xml file
(Inherited from BaseInfo.) |
Name | Description | |
---|---|---|
CheckRequiredColumns |
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.) | |
IsFile |
Returns true if the given document is a file node
(Defined by TreeNodeTypeExtensions.) | |
IsFolder |
Returns true if the given document is a folder node
(Defined by TreeNodeTypeExtensions.) | |
IsRoot |
Returns true if the given document is a root node
(Defined by TreeNodeTypeExtensions.) | |
Serialize |
Returns object data serialized into the XML element.
(Defined by SerializationExtensions.) | |
SubmitToTranslation |
Submits the document to a translation.
(Defined by TranslationExtensions.) | |
ToJSON |
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.) | |
ToXML(XmlWriter, Boolean) | Overloaded.
Writes XML representation of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.) | |
ToXML(String, Boolean) | Overloaded.
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.) | |
ToXML(XmlWriter, ListString, Boolean) | Overloaded.
Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.) |