Share via


Microsoft.SharePoint.WebControls Namespace

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:

<%@ 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.

Classes

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

Structures

  Structure Description
TimeSlotItem

Interfaces

  Interface Description
IDesignerEventAccessor
IDesignTimeHtmlProvider
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.
IFormDelegateControlSource
IPreRenderOverride
ISPCalendarItem
ISPCalendarSettings
IXPathNavigator

Enumerations

  Enumeration Description
ContentDatabaseSectionMode
FeatureLinks.Mode
LayoutsPageBase.RightsCheckModes Specifies the event or events at which the rights of the user are checked.
MenuAlignment Specifies the alignment of a Menu control.
MenuFormat
PeopleEditor.AccountType
PostCacheSubstitutionTextType
SPCalendarBase.ItemType Specifies the type of calendar item.
SPCalendarBase.SPCellBorder
SPCalendarViewType Contains the view type of the calendar.
SPControlMode
SPDataSourceMode Used to specify the type of data that a data-bound Windows SharePoint Services control should query.
SPEncodeMethod
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.