C# Class Engage.Dnn.Publish.Category

Inheritance: Item

Exibir arquivo Open project: EngageSoftware/Engage-Publish Class Usage Examples

Private Properties

Property	Type	Description
CreateCategory	Category
GetCategoryArticles	List

Public Methods

Method	Description
AddCategoryVersion ( IDbTransaction trans, int itemVersionId, int itemId, int sortOrder, int childDisplayTabId ) : void
AddCategoryVersion ( int itemVersionId, int itemId, int sortOrder, int childDisplayTabId ) : void
CascadeChildDisplayTab ( int revisingUser ) : int	Updates the Item.DisplayTabId and ChildDisplayTabId settings of all children of this Category (and their children's children, etc.)
Category ( ) : System
Create ( int portalId ) : Category	Creates an empty Category object
Create ( string name, string description, int authorUserId, int moduleId, int portalId, int displayTabId ) : Category	Creates a Category object that you can continue to modify or save back into the database.,
GetAllChildCategories ( int parentItemId, int portalId ) : DataTable
GetCategories ( int portalId ) : DataTable
GetCategoriesByModuleId ( int moduleId ) : DataTable
GetCategoriesByPortalId ( int portalId ) : DataTable
GetCategoriesHierarchy ( int portalId ) : DataTable
GetCategory ( int itemId ) : Category
GetCategory ( int itemId, bool loadRelationships, bool loadTags ) : Category
GetCategory ( int itemId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Category
GetCategory ( int itemId, int portalId ) : Category
GetCategory ( int itemId, int portalId, bool ignoreCache ) : Category
GetCategory ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Category
GetCategory ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings, bool ignoreCache ) : Category
GetCategory ( string categoryName, int portalId ) : Category
GetCategoryListing ( int parentItemId, int portalId ) : IDataReader
GetCategoryVersion ( int itemVersionId, int portalId ) : Category
GetCategoryVersion ( int itemVersionId, int portalId, bool ignoreCache ) : Category
GetChildCategories ( int parentItemId, int portalId ) : DataTable
GetChildCategories ( int parentItemId, int portalId, int itemTypeId ) : DataTable
GetChildrenInCategoryPaging ( int categoryId, int childTypeId, int maxItems, int portalId, bool customSort, bool customSortDirection, string sortOrder, int index, int pageSize ) : DataTable
GetOldCategoryId ( int itemId ) : int
GetParentCategory ( int childItemId, int portalId ) : int
GetTopLevelCategories ( int portalId ) : DataSet	Returns a dataset of the top level categories available for a specific portal
Import ( int currentModuleId, int portalId ) : void	This method is invoked by the Import mechanism and has to take this instance of a Category and resolve all the id's using the names supplied in the export. hk
Save ( int authorId ) : void
UpdateApprovalStatus ( ) : void

Protected Methods

Method	Description
ResolveIds ( int currentModuleId ) : void

Private Methods

Method	Description
CreateCategory ( string name, string description, int authorUserId, int moduleId, int portalId, int displayTabId ) : Category
GetCategoryArticles ( int itemId, int portalId ) : List

Method Details

AddCategoryVersion() public static method

public static AddCategoryVersion ( IDbTransaction trans, int itemVersionId, int itemId, int sortOrder, int childDisplayTabId ) : void
trans	IDbTransaction
itemVersionId	int
itemId	int
sortOrder	int
childDisplayTabId	int
return	void

AddCategoryVersion() public static method

public static AddCategoryVersion ( int itemVersionId, int itemId, int sortOrder, int childDisplayTabId ) : void
itemVersionId	int
itemId	int
sortOrder	int
childDisplayTabId	int
return	void

CascadeChildDisplayTab() public method

Updates the Item.DisplayTabId and ChildDisplayTabId settings of all children of this Category (and their children's children, etc.)

public CascadeChildDisplayTab ( int revisingUser ) : int
revisingUser	int	The revising user.
return	int

Category() public method

public Category ( ) : System
return	System

Create() public static method

Creates an empty Category object

public static Create ( int portalId ) : Category
portalId	int	The Portal ID of the portal this category belongs to.
return	Category

Create() public static method

Creates a Category object that you can continue to modify or save back into the database.,

public static Create ( string name, string description, int authorUserId, int moduleId, int portalId, int displayTabId ) : Category
name	string	Name of the Category to be created.
description	string	The description/abstract of the category to be created.
authorUserId	int	The ID of the author of this category.
moduleId	int	The moduleid for where this category will most likely be displayed.
portalId	int	The Portal ID of the portal this category belongs to.
displayTabId	int	The Tab ID of the page this Category should be displayed on.
return	Category

GetAllChildCategories() public static method

public static GetAllChildCategories ( int parentItemId, int portalId ) : DataTable
parentItemId	int
portalId	int
return	System.Data.DataTable

GetCategories() public static method

public static GetCategories ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetCategoriesByModuleId() public static method

public static GetCategoriesByModuleId ( int moduleId ) : DataTable
moduleId	int
return	System.Data.DataTable

GetCategoriesByPortalId() public static method

public static GetCategoriesByPortalId ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetCategoriesHierarchy() public static method

public static GetCategoriesHierarchy ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetCategory() public static method

public static GetCategory ( int itemId ) : Category
itemId	int
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, bool loadRelationships, bool loadTags ) : Category
itemId	int
loadRelationships	bool
loadTags	bool
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Category
itemId	int
loadRelationships	bool
loadTags	bool
loadItemVersionSettings	bool
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, int portalId ) : Category
itemId	int
portalId	int
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, int portalId, bool ignoreCache ) : Category
itemId	int
portalId	int
ignoreCache	bool
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Category
itemId	int
portalId	int
loadRelationships	bool
loadTags	bool
loadItemVersionSettings	bool
return	Category

GetCategory() public static method

public static GetCategory ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings, bool ignoreCache ) : Category
itemId	int
portalId	int
loadRelationships	bool
loadTags	bool
loadItemVersionSettings	bool
ignoreCache	bool
return	Category

GetCategory() public static method

public static GetCategory ( string categoryName, int portalId ) : Category
categoryName	string
portalId	int
return	Category

GetCategoryListing() public static method

public static GetCategoryListing ( int parentItemId, int portalId ) : IDataReader
parentItemId	int
portalId	int
return	IDataReader

GetCategoryVersion() public static method

public static GetCategoryVersion ( int itemVersionId, int portalId ) : Category
itemVersionId	int
portalId	int
return	Category

GetCategoryVersion() public static method

public static GetCategoryVersion ( int itemVersionId, int portalId, bool ignoreCache ) : Category
itemVersionId	int
portalId	int
ignoreCache	bool
return	Category

GetChildCategories() public static method

public static GetChildCategories ( int parentItemId, int portalId ) : DataTable
parentItemId	int
portalId	int
return	System.Data.DataTable

GetChildCategories() public static method

public static GetChildCategories ( int parentItemId, int portalId, int itemTypeId ) : DataTable
parentItemId	int
portalId	int
itemTypeId	int
return	System.Data.DataTable

GetChildrenInCategoryPaging() public static method

public static GetChildrenInCategoryPaging ( int categoryId, int childTypeId, int maxItems, int portalId, bool customSort, bool customSortDirection, string sortOrder, int index, int pageSize ) : DataTable
categoryId	int
childTypeId	int
maxItems	int
portalId	int
customSort	bool
customSortDirection	bool
sortOrder	string
index	int
pageSize	int
return	System.Data.DataTable

GetOldCategoryId() public static method

public static GetOldCategoryId ( int itemId ) : int
itemId	int
return	int

GetParentCategory() public static method

public static GetParentCategory ( int childItemId, int portalId ) : int
childItemId	int
portalId	int
return	int

GetTopLevelCategories() public static method

Returns a dataset of the top level categories available for a specific portal

public static GetTopLevelCategories ( int portalId ) : DataSet
portalId	int	The Portal ID that we want to return data for.
return	System.Data.DataSet

Import() public method

This method is invoked by the Import mechanism and has to take this instance of a Category and resolve all the id's using the names supplied in the export. hk

public Import ( int currentModuleId, int portalId ) : void
currentModuleId	int
portalId	int
return	void

ResolveIds() protected method

protected ResolveIds ( int currentModuleId ) : void
currentModuleId	int
return	void

Save() public method

public Save ( int authorId ) : void
authorId	int
return	void

UpdateApprovalStatus() public method

public UpdateApprovalStatus ( ) : void
return	void