See also:
NTier Windows Forms Framework Home
NTier Framework API reference

The FormShowAction type exposes the following members.

Constructors

  NameDescription
Public methodFormShowAction()()()()
Initializes a new instance of the FormShowAction class
Public methodFormShowAction(IEntitySetSource, Type)
Use this constructor to provide the entity to edit and the form type in code.

Methods

  NameDescription
Protected methodCloneCore (Inherited from FormShowActionBase.)
Protected methodCreateCompileTimeCheckBindingMember
Returns a CompileTimeCheckBindingMember that will be used to ensure the data item at the end of 'dataMember' is of type 'expectedType' at compile time.
(Inherited from BoundControlActionBase.)
Public methodDispose()()()() (Inherited from NAction.)
Protected methodDispose(Boolean) (Inherited from FormShowActionBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Inherited from NAction.)
Protected methodGetEntityToEdit
Get an instance of the entity or collection that will actually be shown on the form.
(Inherited from FormShowActionBase.)
Protected methodGetEntityToEditSource
Get the entity data that is used as the source to the entity/collection that will be shown on the form. This entity is branched before it is shown on the form, and GetEntityToEdit is used with the branched data to get the actual entity/collection that is shown on the form.
(Inherited from FormShowActionBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetReferencedBy (Inherited from NAction.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitializeBindingInfoProvider (Inherited from FormShowActionBase.)
Protected methodMemberwiseClone (Inherited from NAction.)
Protected methodNewForm (Inherited from FormShowActionBase.)
Protected methodOnBeforeFormShow (Inherited from FormShowActionBase.)
Protected methodOnBeforeRun (Inherited from FormShowActionBase.)
Protected methodOnEnabledChanged (Inherited from NAction.)
Protected methodOnFormShow (Inherited from FormShowActionBase.)
Protected methodOnQueryEntityToEdit (Inherited from FormShowActionBase.)
Protected methodOnSelectsCollectionOnlyChanged (Inherited from FormShowActionBase.)
Protected methodQueryUserToSave (Inherited from FormShowActionBase.)
Protected methodReportErrorToUser
Reports an error message to the user. Override to show a custom error dialog or message to the user.
(Inherited from FormShowActionBase.)
Protected methodRequiresFormDataSourceType (Overrides FormShowActionBase..::..RequiresFormDataSourceType()()()().)
Public methodRun (Inherited from NAction.)
Protected methodRunCore (Inherited from FormShowActionBase.)
Protected methodShowMessage
Show an informational, warning or error message to the user.
(Inherited from BoundControlActionBase.)
Protected methodSwitchToWaitCursor
Switch the mouse cursor to a wait cursor while saving.
(Inherited from FormShowActionBase.)
Public methodToString (Inherited from NAction.)
Protected methodTryActivateVisibleNonModalForm
Tries to active a non-modal form that is already showing the entity data for 'entityToEdit'.
(Inherited from FormShowActionBase.)

Properties

  NameDescription
Protected propertyBindingInfoProvider
Get an instance of the helper class that is maintains the bound data.
(Inherited from BoundControlActionBase.)
Protected propertyBoundControlDataSourceType
Get the data source type of the container control. This is used by NTier intellisense when the developer is choosing a binding path.
(Inherited from BoundControlActionBase.)
Public propertyCommitActions
Get the actions that should be performed when changes on the form are 'committed' via a FormCommitAction. For example, this property may be set to a FormSaveAction or FormDeleteAndSaveAction.
(Inherited from FormShowActionBase.)
Public propertyCompileTimeValidation (Inherited from FormShowActionBase.)
Protected propertyCompileTimeValidationCore (Overrides FormShowActionBase..::..CompileTimeValidationCore.)
Protected propertyCurrentDataItem
Get the current data item specified by:
HostingControl (or data bound parent).DataSource - the top level data source.
HostingControl (or data bound parent).DataMember - the top level data member.
DataMember - the relative data member.
NOTE: Null will be returned in place of a deleted entity.
(Inherited from BoundControlActionBase.)
Public propertyDisableCompileTimeValidation
Get or set whether to disable designer validation of types and binding members.
(Inherited from FormShowActionBase.)
Public propertyEditBindingPath
Get or set the binding path from the data source on the hosting control that will be used to data bind the form.
Public propertyEditBindingPathCompileTimeCheck
Public propertyEnabled (Inherited from NAction.)
Protected propertyEnabledCore (Inherited from FormShowActionBase.)
Public propertyFormDataSourceType
Get or set the type of the data source that the form expects to bind to.
(Inherited from FormShowActionBase.)
Public propertyFormType
Get or set the type of the form, or form factory that is used to edit the data.
(Inherited from FormShowActionBase.)
Protected propertyHostingComponent (Inherited from BoundControlActionBase.)
Public propertyHostingControl
Get or set the control that hosts the action. Usually this would be a button or menu item.
(Inherited from BoundControlActionBase.)
Public propertyLoadPersistentEntities
Get or set whether the form data is loaded from the underlying data store directly if persistent. If false, the IEntitySet is cloned instead which means the database won't need to be queried.
(Inherited from FormShowActionBase.)
Public propertyModal
Get or set whether the form should be displayed modally.
(Inherited from FormShowActionBase.)
Public propertyReadOnly
Get or set whether the form should display the entity data in read only mode.
(Inherited from FormShowActionBase.)
Public propertyReferencedBy (Inherited from NAction.)
Public propertyRequiresEntitySetSaved
Get or set whether the user will be required to save the current form before the new form is shown.
(Inherited from FormShowActionBase.)
Public propertyResetHasChangesBeforeEdit
Get or set whether to revert EntitySet.HasChanges() to false before showing the form. Set this to false if you want the Save button to be enabled on the shown form as soon as it is shown.
(Inherited from FormShowActionBase.)
Public propertySelectedItemBindingPathCompileTimeCheck (Inherited from FormShowActionBase.)
Protected propertySelectsCollectionOnly (Overrides FormShowActionBase..::..SelectsCollectionOnly.)
Public propertySite (Inherited from BoundControlActionBase.)
Protected propertyVisualTechnology (Inherited from BoundControlActionBase.)

Events

  NameDescription
Public eventBeforeFormShow
Raised before the form is shown to the user.
(Inherited from FormShowActionBase.)
Public eventDisposed (Inherited from NAction.)
Public eventEnabledChanged (Inherited from NAction.)
Public eventFormShow
Raised when the form is to be shown. When this event is hooked, the event handler is responsible for showing the form.
(Inherited from FormShowActionBase.)
Public eventQueryEntityToEdit
Raised when get the entity to edit on the form, before it has been branched / cloned. Throw an exception in the event to cancel showing the form and instead show a message to the user.
(Inherited from FormShowActionBase.)

See Also