SPPageStateControl members

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.

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

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

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

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

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