| TreeProvider Methods |
The TreeProvider type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddRating |
Updates rating value of given document.
|
| AllSites |
Returns true if the given site name value represents all sites
|
| AttachmentSearch |
Searches attachment binary data for search expression.
|
| ClearCheckoutInformation |
Clears the checkout information from the given tree node.
|
| ClearWorkflowInformation |
Clears the workflow information from the given tree node.
|
| CopyNode(CopyDocumentSettings) |
Copies node according to given parameters.
|
| 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.
|
| CopyNode(TreeNode, Int32, Boolean, Int32, Int32, Boolean, String) | Obsolete.
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.
|
| CreateSiteRoot |
Creates site tree root. For purposes of site creation.
|
| DeleteLinks |
Deletes document links to the specified node.
|
| DeleteSiteTree |
Deletes site tree root. For purposes of site deletion.
|
| EnsureRequiredColumns |
Ensures columns required for selection in given column list. Returns the adjusted list
|
 | ExecuteQuery(String, QueryDataParameters) |
Runs specified query with provided parameters.
|
| ExecuteQuery(String, QueryDataParameters, String, String) |
Runs specified query with provided parameters.
|
| ExecuteQuery(String, QueryDataParameters, String, String, Int32, String) |
Executes query and returns result as a dataset.
|
| ExecuteQuery(String, QueryDataParameters, String, String, Int32, String, Int32, Int32, Int32) |
Executes query and returns result as a dataset.
|
| FilterOutDuplicateDocuments |
Filters out duplicate documents (linked ones).
|
| FilterOutLocalizedRows |
Removes nodes of any culture that are translated to required language.
|
| FilterOutLocalizedVersions(DataSet, String, String) |
Removes nodes of default culture that are translated to required language.
|
| FilterOutLocalizedVersions(DataSet, String, String, String) |
Removes nodes of default culture that are translated to required language.
|
| GetClassNamesWhereCondition |
Returns where condition for given class names.
|
| 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.
|
| GetCompleteWhereCondition |
Returns the complete where condition based on the given parameters.
|
| GetCultureWhereCondition |
Returns where condition for given culture.
|
| GetDefaultCultureCode |
Returns default culture code specified in the CMSDefaultCultureCode configuration key.
|
| GetDependencyCacheKeys |
Returns the cache dependencies keys array for the node - cache item keys affected when the node is changed.
|
| GetDocument(IDataContainer, TreeProvider) |
Creates document from given data.
|
| GetDocumentNodeType(IDataContainer, TreeProvider) |
Creates document from given data.
|
| GetDocumentCacheDependencies |
Returns cache dependencies key for the specified document data source.
|
| GetEmptyDataSet |
Returns an empty data set to be filled by the data.
|
| GetNodesOnPathWhereCondition |
Returns where condition for all nodes on the path to the given alias path.
|
| GetOriginalNode |
Returns the original node for given link node in specified culture.
|
| GetRelationshipWhereCondition |
Returns where condition for the given relationship or null if the relationship was not found.
|
| GetUniqueDocumentName |
Returns unique document name for the specified parent node. Does not check for duplicity if duplicity occurs within the currentNodeId.
|
| GetUniqueNodeAlias |
Returns unique node alias for the specified parent node. Does not check for duplicity if duplicity occurs within the currentNodeId.
|
| GetUniqueNodeName |
Returns unique node name for the specified parent node. Does not check for duplicity if duplicity occurs within the currentNodeId.
|
| GetUniqueUrlPath |
Returns unique URL path for the specified parent node. Does not check for duplicity if duplicity occurs within the currentNodeId.
|
| GetUseParentNodeGroupID |
Returns whether NodeGroupID property should be set according to the parent value.
|
| HasRated |
Sets a flag indicating that user rated the document.
|
| ChangeCommunityGroup |
Sets owner group of specified nodes
|
| 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.
|
| ChangeSiteDefaultCulture(String, String) |
Changes default culture of the site.
|
| 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.
|
| CheckDocumentUIPermissions |
Returns whether document permissions should be checked in the content management UI.
|
| InitNodeOrders |
Initializes the node order under specified parent node.
|
| MoveNode(TreeNode, TreeNode, Boolean) |
Moves the node to the specified location.
|
| MoveNode(TreeNode, Int32, Boolean) | Obsolete.
Moves the node to the specified location.
|
| MoveNodeDown(Int32) |
Moves specified node down in the order sequence (down = larger NodeOrder = further in the navigation).
|
| MoveNodeDown(TreeNode) |
Moves specified node down in the order sequence (down = larger NodeOrder = further in the navigation).
|
| MoveNodeUp(Int32) |
Moves specified node up in the order sequence (up = smaller NodeOrder = closer to beginning in the navigation).
|
| MoveNodeUp(TreeNode) |
Moves specified node up in the order sequence (up = smaller NodeOrder = closer to beginning in the navigation).
|
| RememberRating |
Remember that user has rated the document.
|
| RemoveCMSExcludeDocumentsFromSearch |
Filters results with AliasPath in CMSExcludeDocumentsFromSearch key.
|
| ResetRating |
Resets rating values of given document.
|
| Search(String, String, String, String, SearchModeEnum) |
Searches specified node and all child nodes and returns results as a dataset with CMS_TREE data.
|
| Search(String, String, String, String, SearchModeEnum, Boolean) |
Searches specified node and (optionally) all child nodes and returns results as a dataset with CMS_TREE data.
|
| Search(String, String, String, String, SearchModeEnum, Boolean, String) |
Searches specified node and (optionally) all child nodes and returns results as a dataset with CMS_TREE data.
|
| Search(String, String, String, String, SearchModeEnum, Boolean, String, Boolean) |
Searches specified node and returns results.
|
| Search(String, String, String, String, SearchModeEnum, Boolean, String, Boolean, Boolean, String, String) |
Searches data and returns results.
|
| Search(String, String, String, String, SearchModeEnum, Boolean, String, Boolean, Boolean, String, String, Boolean) |
Searches specified node and returns results.
|
| SelectNodes |
Gets the query for all published documents
|
| SelectNodes(String) |
Gets the query for all published documents of specific type
|
| SelectNodes(NodeSelectionParameters) |
Returns nodes matching the provided parameters. Result contains coupled data only if classNames are specified.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| SelectNodesCount |
Returns nodes count matching the provided parameters.
|
| 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.
|
| SelectSingleDocumentNodeType(Int32, Boolean, String) |
Returns single node specified by document ID. If the result is a link to another document original document is returned instead.
|
| SelectSingleNode(NodeSelectionParameters) |
Returns single node matching the provided parameters.
|
| SelectSingleNode(Int32, String) |
Returns single node specified by node ID and culture.
|
| SelectSingleNode(Guid, String, String) |
Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
|
| 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.
|
| SelectSingleNode(String, String, String) |
Returns single node specified by alias path, culture and site name.
|
| SelectSingleNode(Guid, String, String, Boolean) |
Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
|
| SelectSingleNode(Int32, String, Boolean, Boolean) |
Returns single node specified by node ID and culture, optionally combined with default culture.
|
| SelectSingleNode(String, String, String, Boolean, String, Boolean, Boolean, Boolean) |
Returns single node specified by alias path, culture and site name matching the provided parameters.
|
| 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.
|
| SelectSingleNodeNodeType(NodeSelectionParameters) |
Returns single node matching the provided parameters. Result contains coupled data only if classNames are specified.
|
| SelectSingleNodeNodeType(Guid, String, String, Boolean) |
Returns single node specified by node GUID, culture and site name. Does not include the coupled data.
|
| SelectSingleNodeNodeType(Int32, String, Boolean, Boolean) |
Returns single node specified by node ID and culture.
|
| SelectSingleNodeNodeType(String, String, String, Boolean, String, Boolean, Boolean, Boolean) |
Returns single node specified by alias path, culture and site name.
|
| SelectSingleNodeNodeType(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.
|
| SetNodeOrder(Int32, DocumentOrderEnum) |
Sets the specified node order.
|
| SetNodeOrder(Int32, Int32) |
Sets the specified node order.
|
| SetNodeOrder(TreeNode, DocumentOrderEnum) |
Sets the specified node order.
|
| SetNodeOrder(TreeNode, Int32) |
Sets the specified node order.
|
| SetRating |
Sets document new ratings.
|
| SortNodesAlphabetically |
Sort child nodes alphabetically.
|
| SortNodesByDate |
Sort child nodes by date.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
See Also