Packagega.model
Classpublic class GuidedActivity

The GuidedActivity class contains guide properties.



Public Properties
 PropertyDefined By
  enforceValidation : String = "onSubmit"
Specifies when to check for mantatory fields, either when the user submits a form guide, or when a user navigates to the next panel in the form guide.
GuidedActivity
  helpText : String
The form guide help text, in rich text format, specified in Guide Builder.
GuidedActivity
  helpTitle : String
The form guide help title specified in Guide Builder.
GuidedActivity
  helpVideo : String
The URL for an FLV file specified in Guide Builder.
GuidedActivity
  instance : GuidedActivity
[static] [read-only] Returns the singleton instance of this model.
GuidedActivity
  panelTransitionDuration : int = 500
The time, in milliseconds, for the duration of the panel transition.
GuidedActivity
  startupEffectDuration : int = 500
The time, in milliseconds, for the duration of the start-up effect.
GuidedActivity
  submitAll : Boolean = true
When false, field data in an optional panel is cleared when the panel is made invisible.
GuidedActivity
  submitFrom : String
Where the submit button should be clicked.
GuidedActivity
Public Constants
 ConstantDefined By
  SUBMIT_FROM_GUIDE : String = "guide"
[static] A value for the submitFrom property.
GuidedActivity
  SUBMIT_FROM_HOST : String = "hosted"
[static] A value for the submitFrom property.
GuidedActivity
  SUBMIT_FROM_PDF : String = "pdf"
[static] A value for the submitFrom property.
GuidedActivity
  SUBMIT_FROM_PRINT : String = "print"
[static] A value for the submitFrom property.
GuidedActivity
  VALIDATE_ON_PANEL_EXIT : String = "onPanelExit"
[static] A value for the enforceValidation property.
GuidedActivity
  VALIDATE_ON_SUBMIT : String = "onSubmit"
[static] A value for the enforceValidation property.
GuidedActivity
Property Detail
enforceValidationproperty
public var enforceValidation:String = "onSubmit"

Specifies when to check for mantatory fields, either when the user submits a form guide, or when a user navigates to the next panel in the form guide. The value of this property is set using either the VALIDATE_ON_SUBMIT or VALIDATE_ON_PANEL_EXIT constant.

helpTextproperty 
public var helpText:String

The form guide help text, in rich text format, specified in Guide Builder.

This property can be used as the source for data binding.

helpTitleproperty 
public var helpTitle:String

The form guide help title specified in Guide Builder.

This property can be used as the source for data binding.

helpVideoproperty 
public var helpVideo:String

The URL for an FLV file specified in Guide Builder.

This property can be used as the source for data binding.

instanceproperty 
instance:GuidedActivity  [read-only]

Returns the singleton instance of this model.


Implementation
    public static function get instance():GuidedActivity
panelTransitionDurationproperty 
public var panelTransitionDuration:int = 500

The time, in milliseconds, for the duration of the panel transition.

startupEffectDurationproperty 
public var startupEffectDuration:int = 500

The time, in milliseconds, for the duration of the start-up effect.

submitAllproperty 
public var submitAll:Boolean = true

When false, field data in an optional panel is cleared when the panel is made invisible.

submitFromproperty 
public var submitFrom:String

Where the submit button should be clicked.

The value of this property is set using one of the following constants:

Constant Detail
SUBMIT_FROM_GUIDEConstant
public static const SUBMIT_FROM_GUIDE:String = "guide"

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that data submission is performed by the form guide.

SUBMIT_FROM_HOSTConstant 
public static const SUBMIT_FROM_HOST:String = "hosted"

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that the data submission handling is performed by a hosted application, therefore no submit button will appear in the form guide.

SUBMIT_FROM_PDFConstant 
public static const SUBMIT_FROM_PDF:String = "pdf"

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that data submission handling is performed by the PDF. If no PDF is available, then the data sumission is performed by the form guide.

SUBMIT_FROM_PRINTConstant 
public static const SUBMIT_FROM_PRINT:String = "print"

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that the data submission will be in the form of a printed copy of the PDF.

VALIDATE_ON_PANEL_EXITConstant 
public static const VALIDATE_ON_PANEL_EXIT:String = "onPanelExit"

A value for the enforceValidation property. This value is set by the Enforce Validation option in Guide Builder and indicates that validation is performed before navigating to another panel.

VALIDATE_ON_SUBMITConstant 
public static const VALIDATE_ON_SUBMIT:String = "onSubmit"

A value for the enforceValidation property. This value is set by the Enforce Validation option in Guide Builder and indicates that validation is performed when the submit button is clicked.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/ga/model/GuidedActivity.html