ApplicationMgr.CanEdit

Syntax

ControlName_CanEdit( editedFile, editKind, canEditValue, editDenialReasons)

Applies To

ApplicationMgr

Purpose

Occurs when an editing action determines the enabled state or when you explicitly call the ApplicationMgr.CanEdit method.

Remarks

The application can handle this event to modify the conditions that determine when to allow editing actions.

Parameters

editedFile As PropertyObjectFile

[In] Specifies the file being edited.

editKind As EditKinds

[In] Specifies the type of editing action.

canEditValue As Boolean

[In/Out] Pass False to disable the editing action.

editDenialReasons As Long

[In/Out] Specifies a set of EditingDenialReasons flags. When this parameter is non-zero, the flags in this parameter specify reasons why the edit cannot proceed. The application can clear these flags to allow the edit to proceed. For example, when the application integrates with source control systems and the EditingDenialReason_IsReadOnly flag is set, you could attempt to check out the selected file from source control to make it writable and then clear the EditingDenialReason_IsReadOnly flag if the checkout succeeds.

Note You cannot clear the EditingDenialReason_IsNotEditor flag.

See Also

ApplicationMgr.BeginEdit event

ApplicationMgr.CanEdit method

ApplicationMgr.EndEdit event

EditingDenialReasons