FormLetter Class [AX 2012]
Syntax
class FormLetter extends RunBaseBatch
Run On
Called
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
allowEmptyTable | |
|
allowSaveLast | (Inherited from RunBaseBatch.) |
|
batchInfo | Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.) |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
canGoBatch | Returns false (Inherited from RunBaseBatch.) |
.gif "Protected method") |
canGoBatchJournal | Determines whether the class is shown in the list of Journal types. (Inherited from RunBaseBatch.) |
|
canMultiThread | Indicates whether the selected records can be posted in the enhanced batch framework. |
|
canSwapBetweenCS | Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.) |
|
caption | Retrieves the description from the current class by calling the static description method of the class if there is one. (Inherited from RunBaseBatch.) |
|
checkClientOutput | Checks whether the destination for printing the original report or a copy of a report is client-based. |
|
checkClientOutputPrintManagement | Checks whether the selected printers in print management that are used for printing the original reports and the copies of reports are using client output options. |
|
checkCloseDialog | Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.) |
|
checkDocumentData_W | Checks the document date. |
|
checkPrinterSettingsMultiThread | Verifies if the selected printers for printing journals are Application Object Server (AOS) configured printers. |
|
chooseLinesQuery | |
|
cleanupDialog | Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.) |
|
createFromLines | |
|
dialog | Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from RunBase.) |
|
dialogClear | Clears the contents of the dialog box. (Inherited from RunBase.) |
|
dialogInit | Initializes the dialog box. (Inherited from RunBase.) |
|
dialogInternal | (Inherited from RunBase.) |
|
dialogMake | Obtains the dialog from a RunBase class. (Inherited from RunBase.) |
|
dialogPost | Executes after the dialog method has been called. (Inherited from RunBaseBatch.) |
|
dialogPostInit | Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.) |
|
dialogPostRun | Called after the Dialog.run Method class. (Inherited from RunBase.) |
|
dialogReInit | Reinitializes the dialog box. (Inherited from RunBase.) |
|
dialogSelectCtrl | When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.) |
|
dialogTask | When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.) |
|
dialogUpdate | Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.) |
|
dialogUpdateQuery | Updates the query in the dialog box. (Inherited from RunBase.) |
|
doBatch | (Inherited from RunBaseBatch.) |
|
documentStatus | |
|
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
|
formLetterSorting | |
|
getFromDialog | Assigns the dialog values to the internal variables. (Inherited from RunBaseBatch.) |
|
getLast | Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.) |
|
getLastFromCallerFormName | Retrieves a SysLastValue value for the FormLetter form with the caller form name as a differentiator. |
|
getNumAndVoucher | |
|
getRunBase | (Inherited from RunBase.) |
|
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
|
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
|
inGetSaveLast | Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.) |
|
init | Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.) |
|
initAllowEmptyTable | |
|
initBatch | (Inherited from RunBaseBatch.) |
|
initParmDefault | Initializes the internal variables. (Inherited from RunBase.) |
|
interCompanyCalledFromFormletter | |
|
interCompanyCreatedFormletter | |
|
interCompanyMap | |
|
interCompanyParmId | |
|
interCompanyParmSelectFromJournal | |
|
interCompanyPosted | |
|
interCompanySelectFromJournal | |
|
isInBatch | Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.) |
|
isSwappingPrompt | Checks if the program is currently swapping from server to client. (Inherited from RunBase.) |
|
journalTransList | |
|
lastValueDataAreaId | (Inherited from RunBase.) |
|
lastValueDesignName | Retrieves the design name that is used as a differentiator for the retrieval of a SysLastValue value. (Overrides the lastValueDesignName Method.) |
|
lastValueElementName | (Inherited from RunBase.) |
|
lastValueType | (Inherited from RunBase.) |
|
lastValueUserId | (Inherited from RunBase.) |
|
lateSelection | |
|
multiForm | |
|
mustGoBatch | (Inherited from RunBaseBatch.) |
|
mustLoadSaveQuery | Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.) |
|
name | Returns the name of the RunBase class. (Inherited from RunBase.) |
|
new | Initializes a new instance of the FormLetter class. (Overrides the new Method.) |
|
newJournalList | Constructs a record sorted list. |
|
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
|
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
|
numberOfRecords | |
|
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
|
owner | Returns the instance that owns the object. (Inherited from Object.) |
|
pack | Serializes the current instance of the RunBase class. (Inherited from RunBase.) |
|
parmBatchCreatedBy | Gets or sets the BatchCreatedBy parameter. |
|
parmBatchGroupId | Gets or sets the BatchGroupId parameter. |
|
parmBatchJobId | Gets or sets the BatchJobId parameter. |
|
parmCallerFormName | Gets or sets the CallerFormName parameter. |
|
parmCreateFromHistory | Gets or sets the CreateFromHistory parameter. |
|
parmCurrentBatch | Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.) |
|
parmDataSourceRecordsPacked | Gets or sets the DataSourceRecordsPacked parameter. |
|
parmFormletterProformaPrintPacked | Gets or sets the FormletterProformaPrintPacked parameter. |
|
parmHistoryList | Gets or sets the HistoryList parameter. |
|
parmId | Gets or sets the Id parameter. |
|
parmIdSynched | Gets or sets the IdSynched parameter. |
|
parmInBatch | Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.) |
|
parmInterCompanyCompanyId | Gets or sets the InterCompanyCompanyId parameter. |
|
parmJournalRecord | Gets or sets the JournalRecord parameter. |
|
parmLineIdSet | Gets or sets the LineIdSet parameter. |
|
parmLineList | Gets or sets the LineList parameter. |
|
parmPrintAcceptanceReport_RU | Gets or sets the PrintAcceptanceReport_RU parameter. |
|
parmPrintBillOfLading_RU | Gets or sets the PrintBillOfLading_RU parameter. |
|
parmPrintFacture_RU | Gets or sets the PrintFacture_RU parameter. |
|
parmPrintInventBaileeReport_RU | Gets or sets the PrintInventBaileeReport_RU parameter. |
|
parmPrintPosting | Gets or sets the PrintPosting parameter. |
|
parmProgress | Gets or sets the Progress parameter. (Inherited from RunBase.) |
|
parmQueryUsed | Gets or sets the QueryUsed parameter. |
|
parmspecQtyIsSet | Gets or sets the specQtyIsSet parameter. |
|
parmUseUserDefinedDestinations | Gets or sets the value of the UseUserDefinedDestinations field. |
|
prepareForRun | Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.) |
|
printerSettingsFormletter | |
|
printFormLetter | |
|
printGRN_IN | Sets whether a goods receipt note is printed. |
|
printJournal | |
|
printMgmtDocumentType | Identifies the print management document type. |
|
printMgmtNodeType | Identifies the print management node type. |
|
printout | |
|
printPostingReport | |
|
proforma | |
|
progressHide | Hides the Progress form. (Inherited from RunBase.) |
|
progressInit | Initializes the Progress object in RunBase. (Inherited from RunBase.) |
|
progressKill | Kills the Progress object in RunBase. (Inherited from RunBase.) |
|
progressUpdate | |
|
prompt | Displays the dialog from the class dialog and waits for user input. (Inherited from RunBaseBatch.) |
|
promptPack | Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.) |
|
promptUnpack | (Inherited from RunBaseBatch.) |
|
putToDialog | Enables setting the fields that were just added in the RunBase.dialog Method method. This method is called from the RunBase.promptPrim Method method directly following the RunBase.dialogMake Method method. (Inherited from RunBase.) |
|
queryRun | Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.) |
|
reArrangeNow | |
|
reset | Resets the class to its default state. (Inherited from RunBase.) |
|
run | Contains the code that does the actual job of the class. (Inherited from RunBase.) |
|
runBase | Returns the RunBase itself. (Inherited from RunBase.) |
|
runBaseDialogModifyType_RU | (Inherited from RunBase.) |
|
runsImpersonated | Indicates whether the FormLetter class can be used in the enhanced batch framework. (Overrides the runsImpersonated Method.) |
|
saveLast | Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.) |
|
selectFromJournal | |
|
selectFromJournalLines | Updates document lines based on the specified records. |
|
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
|
showBatchTab | (Inherited from RunBaseBatch.) |
|
showClearButton | Determines whether to add a Clear button to the dialog box. If you change the return value to true it will add the button. (Inherited from RunBase.) |
|
showDefaultButton | Determines whether a Default button is to be added to the dialog box. If you change the return value to true, it will add the button. (Inherited from RunBase.) |
|
showDialog | (Inherited from RunBase.) |
|
showIndexFields | If this method returns true, it will look for the first enabled index when you are adding query range fields to the dialog and if a data source does not have any ranges specified. It will also show the visible fields from that index. (Inherited from RunBase.) |
|
showQueryForm | |
|
showQuerySelectButton | (Inherited from RunBase.) |
|
showQueryValues | Determines whether a Select button is to be added to the dialog box. If you change the return value to true, the button will be added. (Inherited from RunBase.) |
|
toString | Returns a string that represents the current object. (Inherited from Object.) |
|
transDate | |
|
unpack | Deserializes the packedClass parameter value to an instance of the RunBase class. (Inherited from RunBase.) |
|
updatePrinterSettingsFormLetter | |
|
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
|
usePrintManagement | |
|
validate | Validates if it is okay to continue. (Overrides the validate Method.) |
|
validateAll | |
|
wait | Pauses a process. (Inherited from Object.) |
|
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
.gif "Static member") |
::companyLogo | |
| |
::createJournalListCopy | |
| |
::descriptionHeight | |
| |
::getFormRecord | |
| |
::inventDimReport | |
| |
::inventDimReportString | |
| |
::isClientOutput | Indicates whether that the output must be delivered to the screen. |
| |
::journalExternalItemId | |
| |
::journalItemId | |
| |
::newClientArgs | |
| |
::reFreshCallerDataSource | Refreshes the calling form data source. |
Top
Inheritance Hierarchy
Object Class
RunBase Class
RunBaseBatch Class
FormLetter Class
ProjFormLetter Class