SP.Ribbon.PageState.Handlers Methods

Applies to: SharePoint Foundation 2010

The following table lists the methods of the SP.Ribbon.PageState.Handlers class.

Methods

Name

Description

addStateChangeDialogHandler

Adds a specified state change dialog handler to the handler array.

GenericCompleteHandler

Defines a generic complete handler.

GenericError

Represents a generic error.

Handlers

Initializes a new instance of the Handlers class.

isApproveEnabled

Determines whether the "Approve" command is enabled.

isCancelApprovalEnabled

Determines whether the "Cancel Approve" command is enabled.

isCheckinEnabled

Determines whether the "Check in" command is enabled.

isCheckoutEnabled

Determines whether the "Check out" command is enabled.

isDeleteEnabled

Determines whether the "Delete" command is enabled.

isDiscardCheckoutEnabled

Determines whether the "Discard Checkout" command is enabled.

isDontSaveAndStopEnabled

Determines whether the "Don’t Save And Stop Editing" command is enabled.

isEditEnabled

Determines whether the "Edit" command is enabled.

isInEditMode

Determines whether the page is currently being edited.

isOverrideCheckoutEnabled

Determines whether the "Override Checkout" command is enabled.

isPublishEnabled

Determines whether the "Publish" command is enabled.

isRejectEnabled

Determines whether the "Reject" command is enabled.

isSaveAndStopEditEnabled

Determines whether the "Save and Stop Editing" command is enabled.

isSaveEnabled

Determines whether the "Save" command is enabled.

isSubmitForApprovalEnabled

Determines whether the "Submit For Approval" command is enabled.

isUnpublishEnabled

Determines whether the "Unpublish" command is enabled.

onCancelButton

Handles the "Cancel" button click event in a modal dialog when the page state changes.

onOkButton

Handles the "OK" button click event in a modal dialog when the page state changes.

registerCommentsHandler

Registers a handler to initialize, validate, and make comments available.

setStateChangeDialogFocusOnNode

Sets the focus of the state change dialog to the specified Document Object Model (DOM) element node.

showStateChangeDialog

Determines whether to show the state change dialog.

Applies To

SP.Ribbon.PageState.Handlers Class

See Also

Reference

SP.Ribbon.PageState Namespace