TreeProvider Class

Provides methods for management of the tree structure.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.TreeProvider

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

Syntax

public class TreeProvider

The TreeProvider type exposes the following members.

Constructors

	Name	Description
Public method	TreeProvider()	Constructor.
Public method	TreeProvider(IUserInfo)	Constructor.

Fields

	Name	Description
Public field Static member	ALL_CLASSNAMES	Supplementary constant to specify all class names.
Public field Static member	ALL_CULTURES	Supplementary constant to specify all document cultures.
Public field Static member	ALL_DOCUMENTS	Supplementary constant to specify all documents.
Public field Static member	ALL_LEVELS	All relative levels.
Public field Static member	ALL_SITES	Supplementary constant to specify all sites.
Protected field	mCombineWithDefaultCulture	Combine the selection result with the default culture records?
Protected field	mPreferredCultureCode	Preferred culture code for the data selection.
Protected field Static member	mProviderAssembly	Provider assembly.
Protected field Static member	mProviderAssemblyName	Provider assembly name.
Protected field	mProviderObject	Search object instance.
Protected field	mUserInfo	Current user info object.

Properties

	Name	Description
Public property	AllowAsyncActions	Indicates whether asynchronous actions should be allowed (log synchronization tasks). By default it is set to TRUE.
Public property	AutomaticallyUpdateDocumentAlias	If true, the document alias should be automatically updated upon document name change.
Public property	BaseCacheKey	Provider base cache key.
Public property	CombineWithDefaultCulture	Indicates if returned nodes should be combined with appropriate nodes of default culture in case they are not localized. It applies only if you're using multilingual support. The default value is false.
Public property	EnableDocumentAliases	Indicates if the document aliases should be generated.
Public property	EnableNotifications	Indicates whether notifications are sent when content changes occur (document updated/inserted/deleted,...). By default it is set to TRUE.
Public property	EnableRating	Indicates whether rating of a document should be updated. By default it is set to TRUE.
Public property	EnsureSafeNodeAlias	If true, node alias will include only allowed characters (turn off only when you perform the validation by yourself or the source data are already valdiated).
Public property	FilterOutDuplicates	If true, duplicate (linked) items are filtered.
Public property	GenerateNewGuid	If true, new GUID is generated for the inserted nodes where required.
Public property	CheckUniqueAttachmentNames	If true, unique attachment names within one document are checked against the database. Turn off only when you perform the validation by yourself.
Public property	CheckUniqueNames	If true, unique node names, document names and aliases are checked against the database. Turn off only when you perform the validation by yourself.
Public property	KeepCheckedInOnInsert	If true, the document stays checked in on the insert operation
Public property	LogEvents	If true, events are log on document update.
Public property	LogIntegration	If true, integration tasks are logged on document update.
Public property	LogSynchronization	If true, synchronization tasks are logged on document update.
Public property	LogWebFarmTasks	If true, web farm tasks are logged on the object update.
Public property	MergeResults	If true, tables from result DataSet are merged into a single table.
Public property	PreferredCultureCode	Preferred culture code to use when none set.
Public property	PreserveACLHierarchy	Obsolete. Indicates whether the ACL hierarchy should be preserved on processed documents.
Protected property Static member	ProviderAssemblyName	Custom provider library assembly.
Protected property	ProviderObject	Returns the provider object.
Public property	SelectAllData	If true, all data are selected. Otherwise only base document data are selected.
Public property	SelectQueryName	Base query name to use for the document selection (for the enhanced selection options only).
Public property	SortMergedResults	If true, merged results are sorted.
Public property	TouchCacheDependencies	If true, cache dependencies are touched on document update.
Public property	UpdateDocumentContent	If true, document content is updated from internal objects.
Public property	UpdatePaths	If true, paths to the document are updated.
Public property	UpdateSKUColumns	If true, SKU columns of the document are updated.
Public property	UpdateTimeStamps	If true, time stamps of the document are updated.
Public property	UpdateUser	If true, user IDs of the document (creator, modifier) are updated.
Public property	UseAutomaticOrdering	If true, automatic ordering is used for new nodes.
Public property	UseCache	If true, request cache is used for documents data.
Public property	UseCustomHandlers	If true, custom handlers are used with Document operations.
Public property	UseParentNodeGroupID	Indicates whether NodeGroupID property should be set according to the parent value.
Public property	UserInfo	Current user info.

Methods

	Name	Description
Public method Static member	AddRating	Updates rating value of given document.
Public method Static member	AllSites	Returns true if the given site name value represents all sites
Public method	AttachmentSearch	Searches attachment binary data for search expression.
Public method Static member	ClearCheckoutInformation	Clears the checkout information from the given tree node.
Public method Static member	ClearWorkflowInformation	Clears the workflow information from the given tree node.
Public method	CopyNode(CopyDocumentSettings)	Copies node according to given settings.
Public method	CopyNode(TreeNode, TreeNode, Boolean)	Copies the node to the specified location, optionally with permissions and child nodes. The copy is named according to the parameter and assigned to given owner and group.
Public method	CreateSiteRoot	Creates site tree root. For purposes of site creation.
Public method	DeleteLinks	Deletes all links including child documents to the specified node.
Public method	DeleteSiteTree	Deletes site tree root. For purposes of site deletion.
Public method Static member	EnsureRequiredColumns	Ensures columns required for selection in given column list. Returns the adjusted list
Public method Static member	FilterOutDuplicateDocuments	Filters out duplicate documents (linked ones).
Public method Static member	FilterOutLocalizedRows	Removes nodes of any culture that are translated to required language.
Public method Static member	FilterOutLocalizedVersions	Removes nodes of default culture that are translated to required language.
Public method Static member	GetClassNamesWhereCondition	Returns where condition for given class names.
Public method	GetCombineWithDefaultCulture	Returns whether nodes should be combined with appropriate nodes of default culture if not localized. This applies only when using multilingual support. The default value is false.
Public method Static member	GetCompleteWhereCondition	Returns the complete where condition based on the given parameters.
Public method	GetDefaultCultureCode	Returns default culture code specified in the CMSDefaultCultureCode configuration key.
Public method Static member	GetDependencyCacheKeys	Returns the cache dependencies keys array for the node - cache item keys affected when the node is changed.
Public method Static member	GetDocument(IDataContainer, TreeProvider)	Creates document from given data.
Public method Static member	GetDocument<NodeType>(IDataContainer, TreeProvider)	Creates document from given data.
Public method Static member	GetDocumentCacheDependencies	Returns cache dependencies key for the specified document data source.
Protected method	GetEmptyDataSet	Returns an empty data set to be filled by the data.
Public method Static member	GetNodesOnPathWhereCondition	Returns where condition for all nodes on the path to the given alias path.
Public method	GetOriginalNode	Returns the original node for given link node in specified culture.
Public method Static member	GetPublishedWhereCondition	Gets the where condition for published documents
Public method Static member	GetRelationshipWhereCondition	Returns where condition for the given relationship or null if the relationship was not found.
Public method	GetUseParentNodeGroupID	Returns whether NodeGroupID property should be set according to the parent value.
Public method Static member	HasRated	Sets a flag indicating that user rated the document.
Public method	ChangeCommunityGroup	Sets owner group of specified nodes
Public method	ChangeCulture	Changes culture of the documents in old culture to the new one. If there is an existing document in new culture, the old culture version is not changed to the new one.
Public method	ChangeSiteDefaultCulture(String, String)	Changes default culture of the site.
Public method	ChangeSiteDefaultCulture(String, String, String)	Changes default culture of the site. Removes old culture from the site and adds the new one. Changes culture of the documents in the old culture to the new one. Doesn't handle collisions of existing documents in new culture.
Public method	CheckDocumentUIPermissions	Returns whether document permissions should be checked in the content management UI.
Public method	InitNodeOrders	Initializes the node order under specified parent node.
Public method	MoveNode(MoveDocumentSettings)	Moves the node according to given settings.
Public method	MoveNode(TreeNode, TreeNode, Boolean)	Moves the node to the specified location.
Public method	MoveNodeDown(Int32)	Moves specified node down in the order sequence (down = larger NodeOrder = further in the navigation).
Public method	MoveNodeDown(TreeNode)	Moves specified node down in the order sequence (down = larger NodeOrder = further in the navigation).
Public method	MoveNodeUp(Int32)	Moves specified node up in the order sequence (up = smaller NodeOrder = closer to beginning in the navigation).
Public method	MoveNodeUp(TreeNode)	Moves specified node up in the order sequence (up = smaller NodeOrder = closer to beginning in the navigation).
Public method Static member	RememberRating	Remember that user has rated the document.
Protected method	RemoveCMSExcludeDocumentsFromSearch	Filters results with AliasPath in CMSExcludeDocumentsFromSearch key.
Public method Static member	ResetRating	Resets rating values of given document.
Public method	Search(String, String, String, String, SearchModeEnum, Boolean, String, Boolean, Boolean, String, String)	Searches data and returns results.
Public method	Search(String, String, String, String, SearchModeEnum, Boolean, String, Boolean, Boolean, String, String, Boolean)	Searches specified node and returns results.
Public method	SelectNodes()	Gets the query for all published documents
Public method	SelectNodes(String)	Gets the query for all published documents of specific type
Public method	SelectNodes(NodeSelectionParameters)	Returns nodes matching the provided parameters. Result contains coupled data only if classNames are specified.
Public method	SelectNodes(Int32, String, String)	Returns nodes specified by node ID, culture and site name. Multiple nodes are returned if ALL_CULTURES passed in cultureCode parameter. Does not select coupled data.
Public method	SelectNodes(String, String, String, Boolean, String, String, String, Int32, Boolean, Int32, String)	Returns nodes specified by node alias path, culture and site name, optionally combined with default culture. Result contains coupled data only if classNames are specified.
Public method	SelectNodes(String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, Boolean)	Returns nodes without coupled data specified by node alias path, culture and site name, optionally combined with default culture.
Public method	SelectNodes(String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, Boolean, Int32, String)	Returns nodes without coupled data specified by node alias path, culture and site name, optionally combined with default culture.
Public method	SelectNodes<NodeType>()	Gets the query for all published documents of specific type
Public method	SelectNodesCount	Returns nodes count matching the provided parameters.
Public method	SelectSingleDocument(Int32, Boolean, String)	Returns single node specified by document ID. If the result is a link to another document original document is returned instead.
Protected method	SelectSingleDocument<NodeType>(Int32, Boolean, String)	Returns single node specified by document ID. If the result is a link to another document original document is returned instead.
Public method	SelectSingleNode(NodeSelectionParameters)	Returns single node matching the provided parameters.
Public method	SelectSingleNode(Int32, String)	Returns single node specified by node ID and culture.
Public method	SelectSingleNode(Guid, String, String)	Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
Public method	SelectSingleNode(Int32, String, String)	Returns single node specified by specified node ID, culture and class name. Most efficient way of getting the document. Result contains coupled data only if classNames are specified.
Public method	SelectSingleNode(String, String, String)	Returns single node specified by alias path, culture and site name.
Public method	SelectSingleNode(Guid, String, String, Boolean)	Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
Public method	SelectSingleNode(Int32, String, Boolean, Boolean)	Returns single node specified by node ID and culture, optionally combined with default culture.
Public method	SelectSingleNode(String, String, String, Boolean, String, Boolean, Boolean, Boolean)	Returns single node specified by alias path, culture and site name matching the provided parameters.
Public method	SelectSingleNode(String, String, String, Boolean, String, String, String, Int32, Boolean, String)	Returns single node specified by alias path, culture and site name matching the provided parameters. Result contains coupled data only if classNames are specified.
Protected method	SelectSingleNode<NodeType>(NodeSelectionParameters)	Returns single node matching the provided parameters. Result contains coupled data only if classNames are specified.
Protected method	SelectSingleNode<NodeType>(Guid, String, String, Boolean)	Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
Protected method	SelectSingleNode<NodeType>(Int32, String, Boolean, Boolean)	Returns single node specified by node ID and culture.
Protected method	SelectSingleNode<NodeType>(String, String, String, Boolean, String, Boolean, Boolean, Boolean)	Returns single node specified by alias path, culture and site name.
Protected method	SelectSingleNode<NodeType>(String, String, String, Boolean, String, String, String, Int32, Boolean, String)	Returns single node specified by alias path, culture and site name matching the provided parameters. Result contains coupled data only if classNames are specified.
Public method	SetNodeOrder(Int32, DocumentOrderEnum)	Sets the specified node order.
Public method	SetNodeOrder(Int32, Int32)	Sets the specified node order.
Public method	SetNodeOrder(TreeNode, DocumentOrderEnum)	Sets the specified node order.
Public method	SetNodeOrder(TreeNode, Int32)	Sets the specified node order.
Public method Static member	SetQueryCultures	Sets the query cultures to include proper combination of cultures for backward compatibility. Use only in case when your code uses string culture parameter, which may have TreeProvider.ALL_CULTURES value
Public method Static member	SetRating	Sets document new ratings.
Public method	SortNodesAlphabetically	Sort child nodes alphabetically by document name.
Public method	SortNodesByDate	Sort child nodes by the date of last modification.