SPPageStateControl members

Article
05/27/2015

Provides an ASP.NET control that handles the Ribbon buttons controlling the state of a Microsoft SharePoint Server wiki or publishing page, such as the CheckInCheckOutButton or the PublishingButton.

The SPPageStateControl type exposes the following members.

Constructors

	Name	Description
	SPPageStateControl	Initializes a new instance of the SPPageStateControl class.

Top

Properties

	Name	Description
	Adapter	(Inherited from Control.)
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	BindingContainer	(Inherited from Control.)
	ChildControlsCreated	(Inherited from Control.)
	ClientID	(Inherited from Control.)
	ClientIDMode	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	Context	(Inherited from Control.)
	ContextUri	Gets the Uniform Resource Identifier (URI) of the context page.
	Controls	(Inherited from Control.)
	CurrentItemCheckoutOwner	identifies the current checkout owner of the item to detect conflicts
	CurrentItemVersion	identifies the current version of the item to detect save conflicts
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DesignMode	(Inherited from Control.)
	EnableTheming	(Inherited from Control.)
	EnableViewState	(Inherited from Control.)
	Events	(Inherited from Control.)
	HasChildViewState	(Inherited from Control.)
	HasError
	ID	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	InDesign	(Inherited from SPControl.)
	InputCommentsClientId	Gets the comments that are input by a client.
	IsChildControlStateCleared	(Inherited from Control.)
	IsTrackingViewState	(Inherited from Control.)
	IsViewStateEnabled	(Inherited from Control.)
	LoadViewStateByID	(Inherited from Control.)
	NamingContainer	(Inherited from Control.)
	Page	(Inherited from Control.)
	PageUri	Gets or sets the Uniform Resource Identifier (URI) of the page that contains the control. (Inherited from SPControl.)
	Parent	(Inherited from Control.)
	RegisterAs	(Inherited from SPControl.)
	RenderingCompatibility	(Inherited from Control.)
	RibbonTrimmer	Gets or sets the values used to correctly trim the ribbon.
	SerializedErrorState
	SerializedPageState
	SerializedPageStatusMessages
	Site	(Inherited from Control.)
	SkinID	(Inherited from Control.)
	StatusBarColor	The current color of the status bar, expressed by the PageStatusBarPriority enum.
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	UniqueID	(Inherited from Control.)
	Version	(Inherited from SPControl.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	ViewStateMode	(Inherited from Control.)
	Visible	(Inherited from Control.)

Top

Methods

	Name	Description
	AddedControl	(Inherited from Control.)
	AddErrorStatus	Add an error message to the status that is permanent for the current page rendering, notably a validation error that can only be remedied by another postback.
	AddParsedSubObject	(Inherited from Control.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	ClearCachedClientID	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	ClearEffectiveClientIDMode	(Inherited from Control.)
	CreateChildControls	(Inherited from Control.)
	CreateControlCollection	(Inherited from Control.)
	DataBind()	(Inherited from Control.)
	DataBind(Boolean)	(Inherited from Control.)
	DataBindChildren	(Inherited from Control.)
	Dispose	(Inherited from Control.)
	EnsureChildControls	(Inherited from Control.)
	EnsureID	(Inherited from Control.)
	EnsureItemSavedIfEditMode(Boolean)	Ensures an item is saved to the server if it is necessary, and forces a save if there are version conflicts.
	EnsureItemSavedIfEditMode(String)	Ensures an item is saved to the server if it is necessary and specifies an event argument.
	EnsureItemSavedIfEditMode(Boolean, String, String)	Ensures an item is saved to the server if it is necessary, forces a save if there are version conflicts, and specifies overwrite and discharge changes command handlers.
	EnsurePageCheckedOut
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindControl(String)	(Inherited from Control.)
	FindControl(String, Int32)	(Inherited from Control.)
	Focus	(Inherited from Control.)
	GetClientSideCommandAction
	GetCurrent
	GetDesignModeState	(Inherited from Control.)
	GetDesignTimeHtml	Returns the control as design-time HTML for editing in Web site development tools such as Microsoft Office FrontPage 2003. (Inherited from SPControl.)
	GetEditPropertiesURLIfAnyMissingRequiredFields	Provides the URL of the editing properties for any required fields that are missing.
	GetHashCode	(Inherited from Object.)
	GetRouteUrl(Object)	(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary)	(Inherited from Control.)
	GetRouteUrl(String, Object)	(Inherited from Control.)
	GetRouteUrl(String, RouteValueDictionary)	(Inherited from Control.)
	GetType	(Inherited from Object.)
	GetUniqueIDRelativeTo	(Inherited from Control.)
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadViewState	(Inherited from Control.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnInit	Raises the OnInit event of the page. (Overrides Control.OnInit(EventArgs).)
	OnLoad	(Overrides Control.OnLoad(EventArgs).)
	OnPageStateChanged	Reloads the page state.
	OnPreRender	Raises the PreRender event. (Overrides Control.OnPreRender(EventArgs).)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	PopulateCommandHandlers	Sets the command handlers that handle the actions that the user selects by clicking the Ribbon buttons.
	PopulateStates
	PopulateStatusMessages	sets the PageStatus member
	RaiseBubbleEvent	(Inherited from Control.)
	RedirectToEditPropertiesPageIfAnyMissingRequiredFields
	RefreshAuthoredItemVersion	Refreshes the current version information of the authored item.
	RemovedControl	(Inherited from Control.)
	Render	(Inherited from Control.)
	RenderChildren	(Inherited from Control.)
	RenderControl(HtmlTextWriter)	(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	(Inherited from Control.)
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from Control.)
	SetDesignModeState	(Inherited from Control.)
	SetErrorCondition	Inserts markup that shows the specified error message along with the specified buttons when the page is rendered or the callback is completed.
	SetErrorDialogScript
	SetGenericBlockingMessage
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from Control.)

Top

Events

	Name	Description
	DataBinding	(Inherited from Control.)
	Disposed	(Inherited from Control.)
	Init	(Inherited from Control.)
	Load	(Inherited from Control.)
	PreRender	(Inherited from Control.)
	Unload	(Inherited from Control.)

Top

Fields

	Name	Description
	ColorNameFromPriority	The colors that are being applied to the status bar. The index into this array is the enum value of the PageStatusBarPriority.
	commandHandlers	Stores an array of SPRibbonCommandHandler objects that manage the buttons on the Ribbon.
	currentState	A Hashtable object filled in the PopulateStates() method with entries to indicate the current state of the page.
	DocLibApprovalEnabledStateName
	DocLibCheckoutRequiredStateName
	DocLibMinorVersionsEnabledStateName
	DocLibVersioningEnabledStateName
	DocLibWorkflowEnabledStateName
	ForceHideStatus
	ForceShowStatus
	InitializeClientSideState
	ItemCancelWorkflowEnabledStateName
	ItemHasCheckedInVersionStateName
	ItemHasCustomizableZonesStateName
	ItemHasFieldControlsStateName
	ItemHasPersonalizableZonesStateName
	ItemHasWorkflowRunningStateName
	ItemIsCheckedOutToCurrentUserStateName
	ItemIsCheckedOutToOtherUserStateName
	ItemIsCheckedOutToSystemUserStateName
	ItemIsDefaultPageStateName
	ItemIsFormsPageStateName
	ItemIsInLibraryStateName
	ItemIsInPersonalViewStateName
	ItemIsInSharedViewStateName
	ItemIsMajorVersionStateName
	ItemIsMasterPageGalleryFileStateName
	ItemIsMinorVersionStateName
	ItemIsPendingApprovalStateName
	ItemIsRejectedStateName
	ItemIsScheduledStateName
	ItemIsWebPartPageStateName
	ItemIsWikiPageStateName
	PageInState
	statusMessages	An array of status messages for the control.
	UserHasApproverRightsStateName
	UserHasContributorRightsStateName
	UserHasDeleteRightsStateName
	UserHasManageWebRightsStateName
	UserHasOverrideCheckoutRightsStateName
	ViewModeHasSaveConflictStateName
	ViewModeIsEditStateName
	ViewModeIsWebPartDesignStateName

Top

Explicit interface implementations

	Name	Description
	IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	IExpressionsAccessor.Expressions	(Inherited from Control.)
	IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	IExpressionsAccessor.HasExpressions	(Inherited from Control.)
	IDesignerEventAccessor.OnDesignerLoad	(Inherited from SPControl.)
	IDesignerEventAccessor.OnDesignerPreRender	(Inherited from SPControl.)
	IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	IControlDesignerAccessor.UserData	(Inherited from Control.)

Top