CategoryPicker Class
The CategoryPicker class enables a user to pick one or more areas graphically.
System.Web.UI.Control
Microsoft.SharePoint.Portal.WebControls.CategoryPicker
Public Constructors
The following table shows the constructors of the CategoryPicker class and a brief description of each.
| Name | Description |
|---|---|
| CategoryPicker | Initializes a new instance of the CategoryPicker class. |
Public Fields
The following table shows the fields of the CategoryPicker class and a brief description of each.
| Name | Description |
|---|---|
| AllowEmpty | Specifies that no selection is allowed. |
| OverrideIsPostBackValue | Specifies a value indicating whether the control should ignore the value of Page.IsPostBack property and to assume Page.IsPostBack is false for the rest of the currect post. The property defaults to false. |
| ParseUrlForID | Specifies that the Web Part parses the URL to determine the preselected area. The default value is true. |
| PurposeMoveCat | Specifies a value indicating whether the purpose of this area picker is for moving areas. If it is, it will prevent users from picking a child area as the parent of the currect area. The default value is false. |
Public Methods
The following table shows the methods of the CategoryPicker class and a brief description of each.
| Name | Description |
|---|---|
| OnInit(System.EventArgs) | Inherits from System.Web.UI.Controls |
| OnLoad(System.EventArgs) | Inherits from System.Web.UI.Controls |
| Render(System.Web.UI.HtmlTextWriter) | Inherits from System.Web.UI.Controls |
Public Properties
The following table shows the properties of the CategoryPicker class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| AccessKeyLocId | Microsoft.SharePoint.Portal.WebControls.LocStringId | Gets or sets the identifier of the access key. |
| AnchorID | String | Gets or sets the identifier of the anchor area from which to anchor the listings. |
| AutoPostBack | Boolean | Gets or sets a value indicating whether the control posts information back to the server each time a user closes the CategoryPicker control. |
| ButtonID | String | Gets or sets the identifier of the button. |
| CallBackMethodName | String | Gets or sets the name of the method to call for client script if the user makes changes. |
| Enabled | Boolean | Gets or sets a value indicating whether the picker is enabled. |
| InitialSelectedID | String | Gets or sets a value to determine if a user is allowed to set the preselected area when the area picker first launches. You need to set the ParseUrlForID field to false before this property takes effect. |
| LinkCSSClass | String | Gets or sets |
| Mode | String | Gets or sets the mode to keywords or areas. |
| MultiSelect | Boolean | Gets or sets a value indicating whether more than one area can be chosen. |
| SelectedCategories | System.Guid | Gets the selected areas. |
| SelectedCategoryPaths | String | Gets the selected area paths. |
| SupportClientSideCallback | Boolean | Gets or sets a value indicating whether client-side callback is supported. |
| TextLocId | Microsoft.SharePoint.Portal.WebControls.LocStringId | Gets or sets the location identifier of the picker link text. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
Microsoft recommends that the user create Web Parts by using the BaseAreaWebPart class. Microsoft does not recommend subclassing this class.
Requirements
Namespace: Microsoft.SharePoint.Portal.WebControls
Platforms: Microsoft Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security