Click or drag to resize
TreeNode Methods

The TreeNode type exposes the following members.

Methods
  NameDescription
Protected methodAddColumnPrefixesWhereCondition
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.)
Protected methodAddContentField
Process search settings of DataClass field and inserts required search field into search fields collection when field is marked as content field.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodAddSearchableField
Process search settings of DataClass field and inserts required search field into search fields collection when field is searchable.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodAllowExternalColumn
Indicates whether a given column is allowed to be saved externally.
(Inherited from AbstractInfoBaseTInfo.)
Public methodAnyItemChanged
Returns true if any of specified columns changed.
(Inherited from AbstractInfoBaseTInfo.)
Public methodArchive
Archives the document.
Protected methodBuildObjectPath
Builds the path from the given column.
(Inherited from BaseInfo.)
Public methodClearCache
Clears the document cache.
Protected methodClearCache(String)
Clears the document cache.
Protected methodClearCachedValues
Clears the cached values depending on the given column value.
(Inherited from BaseInfo.)
Public methodClearData
Clears data from the object.
(Inherited from BaseInfo.)
Public methodClearOutputCache(Boolean)
Clears the output cache for current page.
Public methodClearOutputCache(Boolean, Boolean)
Clears the output cache for current page.
Public methodClone(Boolean)
Creates a clone of the object
(Inherited from AbstractInfoBaseTInfo.)
Public methodCloneNewNodeType
Returns a clone of the node.
Public methodCloneObject
Creates the clone of the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodColumnsChanged
Returns true if at least one column of the column list provided as the first argument was changed.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodCombineColumnNames(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.)
Public methodCombineColumnNames(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.)
Public methodCompareTo
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.)
Public methodContainsColumn
Returns true if the object contains specific column.
(Overrides AbstractCompositeInfo.ContainsColumn(String).)
Public methodCopyDataTo
Copies the node data to the destination node according to the settings.
Protected methodCopyExternalColumns
Copy value of external columns directly via set value
(Inherited from BaseInfo.)
Protected methodCopyMemoryProperties
Copies memory properties
(Inherited from BaseInfo.)
Protected methodCopyProperties
Copies memory properties
(Inherited from AbstractInfoBaseTInfo.)
Public methodCreateDefaultSKU
Creates default E-Commerce SKU for the document if configured, does not save the document. Returns true on success, false on error or null when module entry not found.
Public methodCreateNewVersion
Creates new document version. (Moves document to edit step.)
Public methodDataChanged
Returns true if the object has changed.
Public methodDataChanged(String)
Returns true if the object changed.
(Inherited from AbstractInfoBaseTInfo.)
Public methodDelete
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.)
Public methodDelete(Boolean)
Deletes the document to the recycle bin. Deletes only this culture version of the document to the recycle bin, including the bound product.
Public methodDelete(Boolean, Boolean)
Deletes the document.
Public methodDeleteAllCultures
Deletes all the culture versions of the specified node including the child nodes.
Protected methodDeleteData
Deletes the object.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteDataInternal
Deletes the object data from the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteChildNodes
Deletes the child nodes of all culture versions under the specified parent node.
Protected methodDeleteMetafiles
Deletes the metafiles related to this object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteObject
Deletes the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoDeleteObject.)
Public methodDestroy
Destroys the document with its version history. Destroys only this culture version of the document.
(Overrides BaseInfoDestroy.)
Protected methodDisconnect
Disconnects the collection from the database.
(Inherited from BaseInfo.)
Public methodDispose
Disposes the object.
Protected methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
(Inherited from BaseInfo.)
Protected methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
(Inherited from BaseInfo.)
Protected methodEnsureCodeName
Ensures the code name of the object if not set
(Inherited from BaseInfo.)
Public methodEnsureConsistency
Ensures data consistency.
Protected methodEnsureData
Creates a new data class container within the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodEnsureDefaultValues
Sets the document default values.
Protected methodEnsureGUID
Ensures the GUID of the object
(Inherited from BaseInfo.)
Protected methodEnsureHierarchyColumns
Ensures the IDPath and Level columns.
(Inherited from BaseInfo.)
Protected methodEnsureLastModified
Ensures the last modified time stamp of the object
(Inherited from BaseInfo.)
Protected methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
(Inherited from BaseInfo.)
Protected methodExecuteRemoveDependencyQuery
Executes given query text using specified connection string.
(Inherited from BaseInfo.)
Public methodExecuteWithOriginalData
Executes the given action using original data of the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodExportDefaultData
Exports the default object installation data
(Inherited from BaseInfo.)
Protected methodFinalize
Destructor
(Inherited from BaseInfo.)
Protected methodGetAutomaticCodeName
Gets the automatic code name for the object
(Inherited from BaseInfo.)
Protected methodGetAutomaticProperty
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
(Inherited from BaseInfo.)
Public methodGetBooleanValue
Gets the boolean value from the object.
(Inherited from BaseInfo.)
Protected methodGetColumnNames
Gets the default list of column names for this class
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetComponents
Gets the list of internal components
(Overrides AbstractCompositeInfo.GetComponents.)
Protected methodGetCount
Gets count of the objects filtered by given where condition.
(Inherited from BaseInfo.)
Protected methodGetCurrentObjectPathPart
Builds the path from the given column.
(Inherited from BaseInfo.)
Protected methodGetCustomProperties
Gets list of custom properties.
(Inherited from BaseInfo.)
Protected methodGetData
Returns the data according to the set of input parameters.
(Inherited from BaseInfo.)
Protected methodGetDataQueryInternal
Gets the data query for this object type
(Overrides BaseInfoGetDataQueryInternal.)
Public methodGetDataSet
Returns the DataSet of the node data.
Public methodGetDateTimeValue
Gets the DateTime value from the object.
(Inherited from BaseInfo.)
Protected methodGetDefaultData
Returns the default object installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultDataExportColumns
Returns names of all columns that should be exported with default data as a comma separated string.
(Inherited from BaseInfo.)
Protected methodGetDefaultDataWhereCondition
Gets the where condition to filter out the default installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultObject
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.)
Protected methodGetDependenciesNames
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.)
Protected methodGetDependenciesNamesAuto
Returns a list of object names which depend on this object.
(Inherited from BaseInfo.)
Protected methodGetDependencyCacheKeys
Gets the array of dependency cache keys for current object.
(Inherited from BaseInfo.)
Public methodGetDependencyObjectType
Gets dependency object type
(Inherited from BaseInfo.)
Protected methodGetDependentObjectsWhereConditions
Returns dictionary collection of where conditions selecting dependent objects for each dependent type.
(Inherited from BaseInfo.)
Public methodGetDocumentName
Returns friendly document name.
Public methodGetDoubleValue
Gets the double value from the object.
(Inherited from BaseInfo.)
Protected methodGetEditingPageURL
Gets the object editing page URL.
(Inherited from BaseInfo.)
Protected methodGetExisting
Returns the existing object based on current object data.
(Overrides BaseInfoGetExisting.)
Protected methodGetExistingBase
Returns single info object and ensures correct GUID vs. code name priority is used (if applicable) after resolving provided whereCondition.

If no object match provided whereCondition, null is returned.

(Inherited from BaseInfo.)
Protected methodGetExistingWhereCondition
Gets a where condition to find an existing object based on current object
(Overrides BaseInfoGetExistingWhereCondition.)
Protected methodGetExistingWhereCondition(Boolean)
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.)
Protected methodGetExternalColumnData
Returns the column data from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalColumns
Returns the list of columns registered as the external columns.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalColumnSettings
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.)
Protected methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalPath
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.)
Protected methodGetFieldAttachment
Retrieves the attachment associated with the specified field of type File.
Protected methodGetFieldAttachments
Retrieves an enumerable collection of attachments associated with the specified field of type Attachments.
Public methodGetFileInfo
Returns FileInfo object from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
(Overrides BaseInfoGetFullObjectName(Boolean, Boolean, Boolean).)
Protected methodGetGeneralizedInfo
Gets the generalized info for this object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetGlobalPermissionName
Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
(Inherited from BaseInfo.)
Protected methodGetGroupWhereCondition
Gets the group where condition for the object
(Inherited from BaseInfo.)
Public methodGetGuidValue
Gets the guid value from the object.
(Inherited from BaseInfo.)
Protected methodGetChildDependencies
Gets the child dependencies repository
(Inherited from BaseInfo.)
Protected methodGetChildWhereCondition
Gets the child object where condition.
(Overrides BaseInfoGetChildWhereCondition(WhereCondition, String).)
Protected methodGetIconUrl(Page, String)
Gets the object icon URL
(Overrides BaseInfoGetIconUrl(Page, String).)
Protected methodGetIconUrl(Int32, Int32, Int32)
Gets the object icon URL
(Inherited from BaseInfo.)
Protected methodGetIDPathPartLength
Returns the length of a part of IDPath.
(Inherited from BaseInfo.)
Public methodGetInheritedValue
Returns the inherited value for the document.
Public methodGetIntegerValue
Gets the integer value from the object.
(Inherited from BaseInfo.)
Protected methodGetLastObjectOrder
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.)
Protected methodGetLocalColumnNames
Gets the list of local column names for particular object.
(Overrides AbstractInfoBaseTInfoGetLocalColumnNames.)
Protected methodGetLocalProperties
Gets the list of local properties for particular object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
(Inherited from BaseInfo.)
Protected methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
(Inherited from BaseInfo.)
Protected methodGetNameCollisions
Gets the list of the name collisions of the given object
(Inherited from BaseInfo.)
Protected methodGetNamePathPartColumn
Returns the name of the column which is used to build the NamePath
(Inherited from BaseInfo.)
Protected methodGetObject
Gets the object by specified where condition.
(Inherited from BaseInfo.)
Public methodGetObjectData
Object serialization.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetObjectChildren
Gets the object children repository
(Inherited from BaseInfo.)
Protected methodGetObjectIdentifier
Gets the object identifier that uniquely identifies the object
(Inherited from BaseInfo.)
Protected methodGetObjectKey
Gets the unique string key for the object.
(Overrides BaseInfoGetObjectKey.)
Protected methodGetObjectName
Returns object name combining object type name and object display name.
(Overrides BaseInfoGetObjectName.)
Protected methodGetObjectOrderID
Returns ID of the item being ordered (i.e. NodeID).
(Overrides BaseInfoGetObjectOrderID.)
Protected methodGetObjectTypeForColumn
Gets the object type for the given column or null if the object type is not found or unknown.
(Inherited from BaseInfo.)
Protected methodGetOrderIdentityWhereCondition
Gets order identity where condition to identify the correct node data which are currently ordered
(Overrides BaseInfoGetOrderIdentityWhereCondition.)
Protected methodGetOrderQueryParameters
Creates QueryDataParameters with special macros for object order management.
(Overrides BaseInfoGetOrderQueryParameters(String, String, Boolean).)
Public methodGetOriginalValue
Returns the original value of column.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetOtherBindings
Gets the repository of other bindings
(Inherited from BaseInfo.)
Protected methodGetParent
Returns the parent object.
(Inherited from BaseInfo.)
Protected methodGetPermissionName
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.)
Protected methodGetPermissionObjectType
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.)
Protected methodGetPermissionToCheck
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.)
Protected methodGetPhysicalFiles
Gets DataSet with physical files.
(Inherited from BaseInfo.)
Public methodGetPreviewLink
Returns document preview link.
Public methodGetProperty
Gets the property value.
(Inherited from BaseInfo.)
Protected methodGetPropertyType
Returns the type of given property.
(Overrides AbstractCompositeInfo.GetPropertyType(String).)
Protected methodGetReferencedObject
Obtains the object to which the particular column refers.
Protected methodGetReferringObjects
Gets the repository of depending objects
(Inherited from BaseInfo.)
Protected methodGetRegisteredProperties
Gets list of registered properties.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetRelatedDocuments
Retrieves an enumerable collection of documents related to the current document with the relationship name given by specified field.
Public methodGetSearchDocument
Returns document with dependence on current object type and index.
(Overrides AbstractInfoBaseTInfoGetSearchDocument(ISearchIndexInfo).)
Public methodGetSearchFields
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).)
Public methodGetSearchID
Returns an unique id of current object for search index (documentid;nodeid).
(Overrides BaseInfoGetSearchID.)
Public methodGetSearchImageUrl
Returns URL to current search result item.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetSiblingsQueryInternal
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).)
Protected methodGetSiblingsWhereCondition
Creates where condition according to Parent, Group and Site settings.
(Overrides BaseInfoGetSiblingsWhereCondition.)
Protected methodGetSiteWhereCondition
Gets the site where condition for the object
(Inherited from BaseInfo.)
Public methodGetStringValue
Gets the string value from the object.
(Inherited from BaseInfo.)
Protected methodGetSynchronizedColumns
Gets the list of synchronized columns for this object or null if all columns are synchronized
(Inherited from BaseInfo.)
Protected methodGetThumbnailUrl
Gets the object thumbnail URL
(Inherited from BaseInfo.)
Public methodGetTranslatedCultures
Gets list of culture codes to which is the document translated to.
Protected methodGetTypeSpecificColumnNames
Gets the column names that are specific to the type
Protected methodGetUniqueCodeName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueDisplayName
Returns the unique display name for the specified object.
(Inherited from BaseInfo.)
Protected methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueNameWhereCondition
Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
(Inherited from BaseInfo.)
Protected methodGetUpperTree
Returns the upper tree data for given document.
Public methodGetUsedPageTemplateId
Gets the page template id used by this document.
Public methodGetUsedPageTemplateIdColumn
Gets the page template id used by this document.
Public methodGetValue(String)
Gets the field value.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetValueT(String, T)
Gets the field value converted to a specified type.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
(Inherited from BaseInfo.)
Protected methodGetVirtualFileRelativePath
Returns virtual relative path for specific column Ensures the GUID of the object
(Inherited from BaseInfo.)
Public methodGetWorkflow
Gets node current workflow (depends on document current workflow step or if document is under a workflow scope).
Protected methodHasAutomaticProperty
Returns true if the given column provides an automatic property to access it's binding.
(Overrides AbstractInfoBaseTInfoHasAutomaticProperty(String).)
Public methodChangedColumns
Returns list of column names which values were changed.
(Inherited from AbstractInfoBaseTInfo.)
Public methodStatic memberChangeNodeDocumentType
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.
Protected methodCheckDefaultPermissions
Check universal permissions for an object
(Inherited from BaseInfo.)
Protected methodCheckDependencies
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.)
Public methodCheckIn
Checks the document in.
Protected methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched.
(Inherited from BaseInfo.)
Public methodCheckOut
Checks the document out.
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
(Inherited from BaseInfo.)
Protected methodCheckPermissionsInternal
Checks the permissions of the object.
(Overrides BaseInfoCheckPermissionsInternal(PermissionsEnum, String, IUserInfo, Boolean).)
Protected methodCheckPermissionsWithHandler
Checks the permissions of the object.
(Overrides BaseInfoCheckPermissionsWithHandler(PermissionsEnum, String, IUserInfo, Boolean).)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from BaseInfo.)
Public methodCheckUniqueValues
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.)
Protected methodInitialize(String, IDataContainer, TreeProvider)
Initializes the object created with default constructor. Use it to load existing node from data row.
Protected methodInitialize(String, DataRow, TreeProvider)
Initializes the object created with default constructor. Use it to load existing node from data row.
Protected methodInitObjectsOrder
Inits the proper order of the sibling objects so the order column is consistent.
(Inherited from BaseInfo.)
Protected methodInitObjectsOrderPostprocessing
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization. Does nothing by default.
(Overrides BaseInfoInitObjectsOrderPostprocessing.)
Public methodInsert
Hides the insert method without parameter. Do not use!
(Overrides BaseInfoInsert.)
Public methodInsert(TreeNode, Boolean)
Inserts current node under specified parent node.
Protected methodInsertAsClone
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.)
Protected methodInsertAsCloneInternal
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.)
Protected methodInsertAsClonePostprocessing
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.)
Public methodInsertAsLink
Inserts current node under specified parent node as a document link.
Protected methodInsertAsLinkInternal
Inserts current node under specified parent node as a document link.
Public methodInsertAsNewCultureVersion
Inserts current node as new culture version of the same document.
Protected methodInsertAsNewCultureVersionInternal
Inserts current node as a new culture version of the specified document.
Protected methodInsertCultureData
Inserts the CMS_Document part of the document node.
Protected methodInsertData
Inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodInsertDataInternal
Inserts the object data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodInsertInternal
Inserts current node under specified parent node.
Protected methodInsertSearchFieldToDocument
Inserts given search field and it's value into search document.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodInsertTreeNodeData
Inserts the CMS_Tree part of the document node.
Protected methodInvalidate
Invalidates the object in the object table.
(Inherited from BaseInfo.)
Protected methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
(Inherited from BaseInfo.)
Protected methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
(Inherited from BaseInfo.)
Protected methodIsChildOf
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.)
Protected methodIsModifiedExternally
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.)
Protected methodIsObjectInvalid
Returns true if the object is invalid.
(Inherited from BaseInfo.)
Public methodIsProduct
Returns true if the document represents a product.
Public methodIsProductSection
Returns true if the document type stands for the product section.
Protected methodIsRootNode
Returns true if the document is a root node.
Public methodIsTranslated
Indicates if document is translated to the given culture.
Public methodItemChanged
Returns true if the item on specified column name changed.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodLoadComponentsData
Loads internal components from the given data source
(Overrides AbstractCompositeInfo.LoadComponentsData(IDataContainer).)
Protected methodLoadData
Loads the object data from given data container.
(Overrides AbstractCompositeInfo.LoadData(LoadDataSettings).)
Protected methodLoadDefaultData
Loads the default data to the object.
(Inherited from AbstractInfoBaseTInfo.)
Public methodLoadInheritedValues
Loads the inherited values to the node.
Public methodLogAction
Logs document action to the event log.
Public methodMacroRepresentation
By default, BaseInfo has no special macro representation.
(Inherited from BaseInfo.)
Public methodMakeComplete
Makes the object data complete.
(Overrides AbstractCompositeInfo.MakeComplete(Boolean).)
Public methodMapDocumentName
Maps the document name based on the document type settings.
Public methodMoveToFirstStep
Moves the document to first step in the workflow (removes the workflow information if document is not under a workflow anymore).
Public methodMoveToNextStep
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).
Public methodMoveToPreviousStep
Moves the document to a previous step in the workflow (rejects the document).
Public methodMoveToPublishedStep
Moves the document directly to published workflow step (moves document directly to publish step, skips all following steps).
Public methodStatic memberNew
Creates new instance of an empty un-typed TreeNode.
Public methodStatic memberNew(DataRow)
Creates new instance of given class which must inherit TreeNode and fill it with given data.
Public methodStatic memberNew(String, TreeProvider)
Creates new instance of given class which must inherit TreeNode.
Public methodStatic memberNew(String, DataRow, TreeProvider)
Creates new instance of given class which must inherit TreeNode and fill it with given data.
Public methodStatic memberNewNodeType(DataRow)
Creates new instance of given class which must inherit specified node type and fill it with given data.
Public methodStatic memberNewNodeType(String)
Creates new instance of given class which must inherit specified node type and fill it with given data.
Public methodStatic memberNewNodeType(String, IDataContainer, TreeProvider)
Creates new instance of given class which must inherit specified node type and fill it with given data.
Public methodStatic memberNewNodeType(String, DataRow, TreeProvider)
Creates new instance of given class which must inherit specified node type and fill it with given data.
Protected methodNewObject
Creates a new object from the given DataRow
(Overrides BaseInfoNewObject(LoadDataSettings).)
Protected methodPermissionCheckException
Fires an exception in case authorization result is false (denied or insignificant)
(Inherited from BaseInfo.)
Public methodPropertyPropertyType
Returns the extension property for the object
(Inherited from AbstractObject.)
Public methodPublish
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.
Protected methodReconnect
Reconnects the collection to the database.
(Inherited from BaseInfo.)
Protected methodRegisterExternalColumn
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterExternalColumns
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterGroupedAttachments
Registers the grouped attachments for this document.
Protected methodRegisterProperties
Registers properties of this object.
(Overrides AbstractInfoBaseTInfoRegisterProperties.)
Protected methodRegisterProperty(String, Object, FuncTInfo, Object, Object)
Registers the given parameterized property to the object.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterPropertyTProperty(String, FuncTInfo, Object)
Registers the given property to the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRemoveDocumentDependencies
Removes document dependencies.
Protected methodRemoveObjectDependencies
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
(Inherited from BaseInfo.)
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged.
(Overrides AbstractCompositeInfo.ResetChanges.)
Public methodResetTranslationFlag
Clears 'Document is waiting for translation' flag.
Protected methodRestoreSettings
Restores local settings for object instance.
(Inherited from BaseInfo.)
Public methodRevertChanges
Reverts the object changes to the original values.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
(Inherited from AbstractInfoBaseTInfo.)
Public methodSendNotifications
Raises the notifications events and sends the notifications.
Protected methodSerializationNotSupported
Throws serialization not supported exception
(Inherited from BaseInfo.)
Protected methodSetComponents
Sets the list of internal components
(Overrides AbstractCompositeInfo.SetComponents(IEnumerableIInfo).)
Protected methodSetData
Updates or inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Public methodSetDefaultPageTemplateID
Sets the default document page template ID.
Public methodSetDocumentNameSource(String)
Sets the document name source field to the given value.
Public methodSetDocumentNameSource(String, Boolean)
Sets the document name source field to the given value.
Protected methodSetExternalColumnData
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.)
Public methodSetIntegerValue
Sets the integer value of the Tree node.
Protected methodSetObject
Updates the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoSetObject.)
Protected methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
(Inherited from BaseInfo.)
Protected methodSetObjectOrder
Moves the object to the specified order. The move is done within the object's siblings.
(Inherited from BaseInfo.)
Protected methodSetObjectOrderPostprocessing
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
(Overrides AbstractInfoBaseTInfoSetObjectOrderPostprocessing.)
Protected methodSetParent
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.)
Public methodSetValue(String, Object)
Sets value of the specified node column.
(Overrides AbstractCompositeInfo.SetValue(String, Object).)
Public methodSetValue(String, Object, Boolean)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Public methodSetValue(String, Object, Object)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Protected methodSortAlphabetically
Sort objects alphabetically.
(Inherited from BaseInfo.)
Protected methodStoreSettings
Stores local settings for object instance.
(Inherited from BaseInfo.)
Public methodSubmitChanges(Boolean)
Submits the changes in the object to the database.
(Overrides BaseInfoSubmitChanges(Boolean).)
Public methodSubmitChanges(Boolean, TreeNode)
Submits the changes in the object to the database.
Public methodToMacroString
Returns the default text representation in the macros.
(Inherited from BaseInfo.)
Public methodToString
Returns the text representation of the object
(Inherited from BaseInfo.)
Public methodTouchKeys
Touches the cache dependency keys of the object to flush the dependent cache items.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodTouchParent
Updates the parent object by saving it (to update the timestamp).
(Inherited from BaseInfo.)
Protected methodTryGetAutomaticProperty
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.)
Public methodTryGetProperty(String, Object)
Obtains value of specified property.
(Overrides AbstractInfoBaseTInfoTryGetProperty(String, Object).)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from BaseInfo.)
Public methodTryGetValue
Obtains value of given column.
(Overrides AbstractCompositeInfo.TryGetValue(String, Object).)
Public methodUndoCheckOut
Rolls the checkout operation of the document back.
Public methodUpdate
Updates node data in the database.
(Overrides BaseInfoUpdate.)
Public methodUpdate(Boolean)
Updates node data in the database.
Protected methodUpdateCoupledData
Updates the coupled data of the document node.
Protected methodUpdateCultureData
Updates the CMS_Document part of the document node.
Protected methodUpdateData
Updates the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateDataInternal
Updates the object data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateDocumentContent
Updates the content of the document.
Protected methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
(Inherited from BaseInfo.)
Protected methodUpdateInheritedChildTags
Updates the tags of the child documents with inherited tag group.
Protected methodUpdateInternal
Updates node data in the database.
Protected methodUpdatePhysicalFiles
Saves physical files.
(Inherited from BaseInfo.)
Protected methodUpdateTreeNodeData
Updates the CMS_Tree part of the document node.
Protected methodUpsertData
Updates or inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpsertDataInternal
Upserts the data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodWriteDefaultData
Writes the default object installation data into xml file
(Inherited from BaseInfo.)
Top
Extension Methods
  NameDescription
Public Extension MethodCompare
Compares two BaseInfo objects (data & structure) according to comparison settings given.
(Defined by DataExtensions.)
Public Extension MethodCopyTo
Copies the data of specified columns of the source object to the target object.
(Defined by DataExtensions.)
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodIsFile
Returns true if the given document is a file node
(Defined by TreeNodeTypeExtensions.)
Public Extension MethodIsFolder
Returns true if the given document is a folder node
(Defined by TreeNodeTypeExtensions.)
Public Extension MethodIsRoot
Returns true if the given document is a root node
(Defined by TreeNodeTypeExtensions.)
Public Extension MethodSerialize
Returns object data serialized into the XML element.
(Defined by SerializationExtensions.)
Public Extension MethodSubmitToTranslation
Submits the document to a translation.
(Defined by TranslationExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Top
See Also