Home Library Learn Downloads Support Community
Sign in | United States - English | |
11 out of 33 rated this helpful - Rate this topic

Microsoft.SharePoint.WebControls Namespace

Windows SharePoint Services 3
Contains ASP.NET server controls that are used on site and list pages in a SharePoint site.

The major class, SPControl, provides methods for getting or setting the context of requests and serves as the base class from which other controls in this namespace derive.

All classes in this namespace require that a page directive like the following be included in the ASPX page containing the control:

Copy 
<%@ Register Tagprefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" 
   Assembly="Microsoft.SharePoint, Version=11.0.0.0, Culture=neutral, 
   PublicKeyToken=71e9bce111e9429c" %>

You can obtain the PublicKeyToken value for the current Windows SharePoint Services deployment from the default.aspx file in the Local_Drive:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\SiteTemplates\STS folder, or from information provided for the Microsoft.SharePoint assembly at Local_Drive:\%WINDOWS%\assembly in Windows Explorer.

  Class Description
Public class ActionsMenu Represents an Actions menu button on a toolbar.
Public class AddGroupEventArgs  
Public class AddLinkEventArgs Event argument to allow consumers of FeatureLinkSections and FeatureLinks to listen as links are added and make any desired modifications.
Public class AddMenuItemEventArgs  
Public class AdministrationDataSourceView  
Public class AggregateDataSource  
Public class AggregateDataSourceView  
Public class AlertMeButton Represents the AlertMe button.
Public class AllContentsViewSelectorMenu Represents the all site content view selector menu control.
Public class AllDayEventField Renders the All Day Event field on various forms.
Public class AlphaImage  
Public class AppendOnlyHistory Represents the version history of a list item.
Public class ApplicationPageLink Renders the URL to application pages, such as weUrl/_layouts/settings.aspx.
Public class ApprovalButton Represents the Approval button.
Public class ApprovalMessage Conditionally renders a message that indicates that the list's content-approval property has been set to true.
Public class ApprovalStatus Renders information whether or not the list item has been approved.
Public class AspMenu Represents an AspMenu control.
Public class AspMenuDesigner Provides design-time support in a visual designer for the AspMenu control.
Public class AssignToEmailMessage  
Public class AttachmentButton Represents the Attachment button.
Public class AttachmentsField Renders a field to which a file is attached on a form page (not a list view page).
Public class AttachmentUpload  
Public class AttendeeEmailResponse  
Public class AttendeeField  
Public class BackLinksIterator  
Public class BaseChoiceField Provides core functionality for controls that render fields (on form pages, but not on list view pages) whose value is usually selected by users from a set of options, such as a drop-down list, a set of option buttons, or a set of check boxes.
Public class BaseFieldControl Renders a field on a form page (not a list view page) by using one or more child controls such as a label, link, or text box control.
Public class BaseNumberField Provides core functionality for classes that render a field on a form page (not a list view page) as a number.
Public class BaseTextField Provides core functionality for controls that render a field on a form page (not a list view page) as a text box, including controls whose text value is a numeral with no letters.
Public class BaseXmlDataSource  
Public class BooleanField Renders a field on a form page (not a list view page) as a single check box.
Public class BpScript Inserts the server control that is used to open the Rich Text Editor in a Basic Page.
Public class ButtonSection Represents the ButtonSection control.
Public class CalculatedField Renders a calculated field on a form page (not a list view page).
Public class CallbackMenuGenerationEventArgs  
Public class ChangeContentType  
Public class ChangePasswordButton Represents the Change Password button.
Public class CheckBoxChoiceField Represents the field control for the Checkbox (multi-choice) field.
Public class CheckInCheckOutButton Represents the Check In/Check Out button.
Public class ClaimReleaseTaskButton Represents the Claim Release Task button.
Public class CompositeField  
Public class ComputedField Displays form behavior that is inherited from BaseFieldControl.
Public class ConditionalEnable  
Public class ContentDatabaseSection  
Public class ContextSelector  
Public class CopySourceInfo  
Public class CopySourceUrlInfo  
Public class CreatedModifiedInfo  
Public class CreationType Renders a link to an e-mail information page for a list item that is created by e-mail.
Public class CrossProjectLinkField  
Public class CssLink Inserts a LINK element into the resulting HTML page and applies an external style sheet(s) defined by CssRegistration.
Public class CssRegistration CssRegistration registers a cascading style sheet (CSS) file. CssLink reads this registration to insert a LINK element into the resulting HTML page and apply the external style sheet(s) defined by
Public class CurrencyField Renders a field on a form page (not a list view page) as a currency value.
Public class CustomJSUrl Establishes a reference to a custom JavaScript file containing script to run on the page.
Public class DailyCalendarView  
Public class DailyTimeSlotRow  
Public class DataSourceCollection  
Public class DataTableDataSourceView  
Public class DateTimeControl Represents a DateTime control.
Public class DateTimeField Represents a field control that contains date and time values.
Public class DelegateControl A generic control that is able to render an ASP.NET control. Delegate controls make their child candidate controls pluggable and replaceable.
Public class DeleteItemButton Represents the Delete Item button.
Public class DeleteItemVersionButton Represents the Delete Item Version button.
Public class DesignModeConsoleContainer  
Public class DialogMaster  
Public class DiffSelectorIterator  
Public class DistributionListsApprovalButton Represents the Distribution Lists Approval button.
Public class DocumentConversionsLoadBalancerPicker  
Public class DocumentLibraryFields  
Public class DocumentTransformersInfo  
Public class DropDownChoiceField  
Public class DVCheckBoxList  
Public class DVDropDownList  
Public class DVListBox  
Public class DVRadioButtonList  
Public class EditDocumentLink  
Public class EditItemButton Represents the Edit Item button.
Public class EditSeriesButton Represents the EditSeries button.
Public class EmailCalendarMessage  
Public class EncodedLiteral  
Public class EnterFolderButton Represents the EnterFolder button.
Public class EntityEditor  
Public class EntityEditorWithPicker  
Public class ExitDesignModeControl  
Public class ExpandableDropDownList Represents the ExpandableDropDownList.
Public class ExportWebPartButton Represents the ExportWebPart button.
Public class FeatureLinks  
Public class FeatureLinkSections  
Public class FeatureMenuTemplate  
Public class FieldDescription  
Public class FieldLabel Conditionally renders the name of a field as a label by using a RenderingTemplate control.
Public class FieldMetadata Provides core rendering metadata applicable to all fields in Windows SharePoint Services 3.0.
Public class FieldProperty Represents a property of a field; that is, a column, on a list.
Public class FieldValue Represents a field value. For more information about creating custom field value classes, see Custom Field Value Classes.
Public class FileField Renders a field that links to a file on a form page (not a list view page) in a document library.
Public class FileUploadedMessage  
Public class FolderFormFields  
Public class FormattedString Renders a string formatted with .Net Composite Formatting.
Public class FormattedStringWithListType  
Public class FormButton Represents the Form button.
Public class FormComponent FormComponent is a top-level control that supports all basic methods and properties for all form-rendering and field-rendering controls, such as ControlMode, templates, and logic for conditional rendering.
Public class FormDigest Inserts a security validation within the form of an .aspx page.
Public class FormField A generic field control that instantiates a basic field control that is based on the field type..
Public class FormToolBar Represents the FormToolBar.
Public class Gantt This class and its members are not intended to be used directly from your code.
Public class GenericInformationBar Represents the GenericInformationBar.
Public class GlobalGalleryActionsMenu  
Public class GoBackButton Represents the GoBack button.
Public class GoToCopySourceLink  
Public class GroupedDropDownList  
Public class GroupedItemPicker  
Public class GroupPermissions  
Public class HierarchicalDesigner  
Public class HtcMenu This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuClientFiles This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuItem This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuItemCollection This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuOption This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuSeparator This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcMenuUtility This type supports Windows SharePoint Services and is not intended to be used directly from your code.
Public class HtcSubMenu This type or member supports Microsoft Windows SharePoint Services and is not intended to be used directly from your code.
Public class InformationBar  
Public class InitContentType  
Public class InputFormCheckBox  
Public class InputFormCheckBoxList Represents a InputFormCheckBoxList.
Public class InputFormCheckBoxListValidator Represents a InputFormCheckBoxListValidator.
Public class InputFormCompareValidator Represents a InputFormCompareValidator.
Public class InputFormControl Represents an InputForm control.
Public class InputFormCustomValidator Represents the InputFormCustomValidator.
Public class InputFormRadioButton Represents the InputForm radio button.
Public class InputFormRangeValidator Represents the InputFormRangeValidator.
Public class InputFormRegularExpressionValidator Represents a InputFormRegularExpressionValidator.
Public class InputFormRequiredFieldValidator Represents the InputFormRequiredFieldValidator.
Public class InputFormSection Represents the InputFormSection.
Public class InputFormTextBox Represents the InputFormTextBox.
Public class ItemHiddenVersion  
Public class LayoutsPageBase Represents an application page (sometimes called a "_layouts" page) to which access can be limited to users that possess certain rights.
Public class LinkSection  
Public class LinksTable  
Public class ListFieldIterator Renders each field in a list item, with some possible exceptions.
Public class ListFormPageTitle  
Public class ListItemProperty Returns a property of a list item.
Public class ListProperty Returns a property of a list.
Public class ListView Renders a list by using a specified view.
Public class ListViewByQuery Renders a list view within a Web Part or ASPX page according to a specified query.
Public class ListViewSelector  
Public class LookupField Renders a lookup field on a form page (not a list view page).
Public class ManageCopiesButton Represents the ManageCopies button.
Public class ManagePermissionsButton Represents the ManagePermissions button.
Public class Menu Represents a custom menu for the Web Part page.
Public class MenuItemTemplate Represents a control that creates an item in a drop-down menu.
Public class MenuSeparatorTemplate  
Public class MenuTemplate Represents the MenuTemplate control which holds menu template items.
Public class MergeButton Represents the Merge button.
Public class ModifySettingsLink  
Public class MonthlyCalendarView  
Public class MultiPageGoBackButton Represents the MultiPageGoBack button.
Public class MultipleLookupField  
Public class MWSActionsMenu  
Public class MWSListViewSelector  
Public class MWSNewMenu  
Public class MWSSettingsMenu  
Public class MWSViewSelectorMenu  
Public class MyAlertsButton Represents the MyAlerts button.
Public class MyRegionalSettingsButton Represents the My Regional Settings button.
Public class Navigation Inserts a navigation bar into a page on a SharePoint site.
Public class NewItemButton Represents the NewItem button.
Public class NewMenu  
Public class NextPageButton Represents the NextPage button.
Public class NoteField Renders a field on a form page (not a list view page) as a text box for recording notes with multiple lines.
Public class NumberField Renders a field on a form page (not a list view page) as a number.
Public class OWSControl Ensures that all OWSForm server controls are contained within an <OWSForm> tag.  Obsolete.
Public class OWSDateField Represents a server control for a field that contains date and time values.   Obsolete.
Public class OWSForm Inserts a server control on the .aspx page and renders the JavaScript that is used in the form.   Obsolete.
Public class OWSNumberField Represents a server control for a field that contains numbers.   Obsolete.
Public class OWSSubmitButton Represents a server control for a submit button.   Obsolete.
Public class PageModeIndicator  
Public class PagingButton Represents the Paging button.
Public class ParentInformationField  
Public class PasswordTextBox  
Public class PasswordTextBoxValidator  
Public class PeopleEditor Represents a PeopleEditor object in a PeoplePicker control.
Public class PeopleEditorEntityDataKeys  
Public class PeoplePickerDialog Represents a PeoplePickerDialog object in a PeoplePicker control.
Public class PeopleQueryControl  
Public class PersistedObjectContextSelector  
Public class PersonalActions  
Public class PickerDialog  
Public class PickerEntity  
Public class PickerItem  
Public class PickerQueryControlBase  
Public class PickerResultControlBase  
Public class PortalConnection Inserts a connection to a portal site onto the page if a portal site exists.
Public class PostCacheSubstitutionText  
Public class PreReleaseFeedback   Obsolete.
Public class ProjectProperty Returns a global property of the current Web site.
Public class PublishButton Displays a publish button on a form that is used to publish a list item, usually a blog post or comment. When this button is clicked, the draft version of the current list item is approved.
Public class RadioButtonChoiceField  
Public class RatingScaleField  
Public class RecentChangesIterator  
Public class RecentChangesMenu  
Public class RecurrenceDataControl  
Public class RecurrenceField Renders a field that holds recurrence information for a meeting list item on a form page (not a list view page).
Public class RelatedTasks Inserts the Actions section of the View bar into the .aspx page.
Public class RelinkButton Represents the Relink button.
Public class RenderingTemplate Represents a hybrid Control-ITemplate object that can serve as a template for classes derived from TemplateBasedControl and can be manipulated, and called from .aspx pages, as any other control.
Public class RenderingTemplateContainer  
Public class RepeatedControls  
Public class RequiredFieldMessage  
Public class RestoreItemVersionButton Displays a Restore Item button on a form. The Restore Item button renders on a form as an image button with associated text.
Public class ReturnLink  
Public class RichTextField A field control for the Note field type when the RichText property is set to true.
Public class RobotsMetaTag  
Public class RssLink  
Public class SaveAsDraftButton Displays a Save button on a form to enable a user to save a draft version of a SharePoint list item.
Public class SaveButton Provides a button, usually on a form toolbar, that is used to save a new or edited list item on the form.
Public class SchedulePicker  
Public class ScriptLink Renders a page using resources, for example, script files, that the page references.
Public class SearchArea  
Public class ServerSelector  
Public class SettingsMenu  
Public class SimpleQueryControl  
Public class SiteActions  
Public class SiteAdministrationSelector  
Public class SiteLogoImage  
Public class SoapDataSource  
Public class SoapDiscoveryLink  
Public class SPBoundField  
Public class SPCalendarBase Represents the calendar base class.
Public class SPCalendarContainer Represents the calendar container.
Public class SPCalendarDataSource Represents the calendar data source.
Public class SPCalendarItem Represents a calendar item.
Public class SPCalendarItemCollection Represents a collection of calendar items.
Public class SPCalendarItemContainer Represents the calendar item container.
Public class SPCalendarNavigator Wraps one or more navigation controls; specifically targets calendar views.
Public class SPCalendarTabContainer Represents the calendar tab container.
Public class SPCalendarTabs Responsible for rendering tabs that represent choices of different calendar view types.
Public class SPCalendarView Represents the CalendarView control hosted inside a ListViewWebPart.
Public class SPCompositeControl  
Public class SPControl Provides methods for getting or setting the context of the request and serves as the base server control from which other controls in the Microsoft.SharePoint.WebControls namespace derive.
Public class SPControlDesigner  
Public class SPControlTemplateManager  
Public class SPDataSource Represents Windows SharePoint Services data to data-bound controls.
Public class SPDataSourceView Supports the SPDataSource control and provides an interface for data-bound controls to perform operations against Windows SharePoint Services data.
Public class SPDataSourceViewPropertyDescriptor Describes properties exposed by the SPDataSourceViewResultItem class.
Public class SPDataSourceViewResultItem Provides custom type information for result item objects that are returned by the SPDataSourceView class.
Public class SPDatePickerControl  
Public class SPGridView Represents a grid view that looks and behaves like a tree view.
Public class SPGridViewPager Represents a pager control for use with the SPGridView control.
Public class SPGridViewRow Represents a control that adds group-by support to a SPGridViewRow.
Public class SPGridViewRowAttributeValue  
Public class SPHierarchyDataSourceControl Provides hierarchical views of SharePoint sites, lists, and folders.
Public class SPHtmlSelect  
Public class SPLinkButton Represents the Link button.
Public class SPMenuField Provides a data-bound drop-down menu to be used in place of BoundField, TemplateField, or similar controls.
Public class SPMonthPickerControl  
Public class SPNavigationManager  
Public class SPRememberScroll  
Public class SPSecurityTrimmedControl Conditionally renders the contents of the control to the current user only if the current user has permissions defined in the PermissionString.
Public class SPSiteMapDataSourceDesigner  
Public class SPSiteMapPathDesigner  
Public class SPSqlDataSource  
Public class SPToolBarButton Displays the ToolBar button.
Public class SPTreeView Displays hierarchical data, such as a table of contents, in a tree structure.
Public class SPWorkflowDataSource  
Public class SPWorkflowDataSourceView  
Public class SPXmlDataSource  
Public class SubMenuTemplate  
Public class SubmitCommentButton Represents the SubmitComment button.
Public class SurveyFieldIterator  
Public class TableResultControl  
Public class TemplateBasedControl Represents a control that is defined by a template rather than by the schema of the list.
Public class TemplateContainer  
Public class TemplatePicker This class is reserved for internal use and is not intended to be used directly from your code.
Public class TextField Renders a field on a form page (not a list view page) as a single-line text box.
Public class Theme Applies a theme to an .aspx page.
Public class ToolBar  
Public class ToolBarButton Represents the ToolBar button.
Public class ToolBarMenuButton Represents the ToolBar Menu button.
Public class TopologyView  
Public class TopologyViewWebPart  
Public class UnlinkCopyButton Represents the UnlinkCopy button.
Public class UnsecuredLayoutsPageBase Represents an application page, sometimes called a layouts page, that can request certain resources and verify that the client has not been disconnected.
Public class UpdateableHierarchicalView  
Public class UploadMenu Represents the Upload menu.
Public class UrlField Renders a field that represents a URL on a form page (not a list view page) by using one or more child controls.
Public class UrlNameValidator Checks for invalid characters in a site name.
Public class UrlPathValidator Checks for invalid characters in a URL path.
Public class UrlRedirector Sets the HTTP 301 response code to tell the browser a url has moved.
Public class UrlValidator  
Public class UserControlContainerDesigner  
Public class UserField Renders a field that represents a set of one or more users or groups on a form page (not a list view page) by using a PeopleEditor child control.
Public class UserInfoListDeleteItemButton Represents the UserInfoListDeleteItem button.
Public class UserInfoListEditItemButton Represents the UserInfoListEditItem button.
Public class UserInfoListFormToolBar  
Public class VersionDiff  
Public class VersionDiffIterator  
Public class VersionHistoryButton Represents the VersionHistory button.
Public class ViewHeader  
Public class ViewIcon  
Public class ViewSearchForm Inserts a view search form into the .aspx page.
Public class ViewSelector Represents a server control that is used to select a view of a list.
Public class ViewSelectorMenu  
Public class ViewToolBar  
Public class ViewWebPartXmlButton Represents the ViewWebPartXml button.
Public class WebApplicationSelector  
Public class WebPartGalleryPicker  
Public class WebPartPageContents Inserts a list of Web Parts contained within a Web Part Page into a page for managing the Web Parts.
Public class WebPartPageMaintenanceMessage  
Public class WeeklyCalendarView  
Public class WeeklyDaySlot  
Public class Welcome  
Public class WikiEditButton Represents the WikiEdit button.
Public class WikiEditItemButton Represents the WikiEditItem button.
Public class WikiFileField Contains the file name of a Wiki page in the form for creating or editing Wiki pages.
Public class WikiIncomingLinksButton Represents the WikiIncomingLinks button.
Public class WikiPageHistoryButton Represents the WikiPageHistory button.
Public class WorkflowForm  
Public class WorkflowsButton Represents the Workflows button.
Public class XmlUrlDataSource  
  Interface Description
Public interface IDesignerEventAccessor  
Public interface IDesignTimeHtmlProvider  
Public interface IFieldEditor When implemented by a class that inherits from the UserControl, class, this class assists in the rendering of a field property editor control on a new column creation page or a column edit page, which in Windows SharePoint Services 3.0 are the New Site Column, Change Site Column, Create Column, and Change Column pages.
Public interface IFormDelegateControlSource  
Public interface IPreRenderOverride  
Public interface ISPCalendarItem  
Public interface ISPCalendarSettings  
Public interface IXPathNavigator  
  Structure Description
Public structure TimeSlotItem  
  Enumeration Description
Public enumeration ContentDatabaseSectionMode  
Public enumeration FeatureLinks.Mode  
Public enumeration LayoutsPageBase.RightsCheckModes Specifies the event or events at which the rights of the user are checked.
Public enumeration MenuAlignment Specifies the alignment of a Menu control.
Public enumeration MenuFormat  
Public enumeration PeopleEditor.AccountType  
Public enumeration PostCacheSubstitutionTextType  
Public enumeration SPCalendarBase.ItemType Specifies the type of calendar item.
Public enumeration SPCalendarBase.SPCellBorder  
Public enumeration SPCalendarViewType Contains the view type of the calendar.
Public enumeration SPControlMode  
Public enumeration SPDataSourceMode Used to specify the type of data that a data-bound Windows SharePoint Services control should query.
Public enumeration SPEncodeMethod  
Public enumeration TemplateOverride Specifies whether a TemplateBasedControl object should render its Template or AlternateTemplate or whether it should let the logic of its own ControlTemplate determine whether its Template or AlternateTemplate is rendered.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
SharePoint.WebControls Registration Directive Version Number
I think the Version number used in the controls' registration directive above may be wrong. I've used Version 12.0.0.0 since its V3 and it worked.

<%

@RegisterTagprefix="SharePoint"Namespace="Microsoft.SharePoint.WebControls"Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
History