FormLetter Class

class FormLetter extends RunBaseBatch

Run On

Called

Methods

Method

Description

allocateNumAndVoucher

allowCreateParmTable

allowEmptyTable

allowSaveLast

(Inherited from RunBaseBatch.)

batchInfo

Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)

callerFormDataSource

cancelTimeOut

Cancels a previous method call to the Object::setTimeOut Method. (Inherited from Object.)

canGoBatch

Returns false (Inherited from RunBaseBatch.)

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.)

canSwapBetweenCSPrim

Returns whether it is possible to pack the class, reinstantiate a new class on the client or server, and unpack the packed class into the new class. (Inherited from RunBase.)

caption

(Inherited from RunBaseBatch.)

checkAOSPrinters

Verifies if selected printers for printing original and copy of reports are Application Object Server (AOS) configured printers.

checkAOSPrintersPrintManagement

Verifies if selected printers in print management, for printing an original and a copy of reports are Application Object Server (AOS) configured printers.

checkCloseDialog

Must be called in the RunBase dialog CloseOk method. (Inherited from RunBase.)

checkLedgerPeriod

Determines whether posting in the ledger period is allowed.

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

createJournal

Posts a selected header record into journals.

dialog

Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from RunBase.)

dialogClear

Should clear the contents of the dialog. (Inherited from RunBase.)

dialogInit

Initializes the dialog. (Inherited from RunBase.)

dialogMake

Obtains the dialog from a RunBase class. (Inherited from RunBase.)

dialogPost

(Inherited from RunBaseBatch.)

dialogPostInit

Called right after the RunBase.dialogInit Method. (Inherited from RunBase.)

dialogPostRun

Called after Dialog.run Method. (Inherited from RunBase.)

dialogReInit

Reinitializes the dialog. (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 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. (Inherited from RunBase.)

documentStatus

endJournalLedger

endJournalLineLedger

endUpdate

Ends the update of selected records.

equal

Determines whether the specified object is equal to the current one. (Inherited from Object.)

formLetterSorting

getFromDialog

(Inherited from RunBaseBatch.)

getLast

Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)

getNumAndVoucher

getSplitDeliveryInformation

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.)

initJournal

initJournalLine

initJournalLineLedger

initParmDefault

Intializes the internal variables. Called when no SysLastValue record can be found, in SysLastValue.GetLast(). (Inherited from RunBase.)

initRecordListInventReportDimHistory

initSysSign

(Inherited from RunBase.)

interCompanyCalledFromFormletter

interCompanyCompanyId

interCompanyCreatedFormletter

interCompanyMap

interCompanyParmId

interCompanyParmLineClosed

interCompanyParmLineQty

interCompanyParmSelectFromJournal

interCompanyPost

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.)

isSysSignUsed

(Inherited from RunBase.)

journal

journalTransList

lastValueDataAreaId

(Inherited from RunBase.)

lastValueDesignName

(Inherited from RunBase.)

lastValueElementName

(Inherited from RunBase.)

lastValueType

(Inherited from RunBase.)

lastValueUserId

(Inherited from RunBase.)

mayJournalBePosted

multiForm

mustGoBatch

(Inherited from RunBaseBatch.)

mustLoadSaveQuery

Determines whether the last query must be loaded and saved when you leave the form. Called from SysQueryForm. (Inherited from RunBase.)

name

Returns the name of the RunBase class. (Inherited from RunBase.)

new

Overridden.

newJournalList

Constructs a record sorted list.

notify

Releases the hold on an object that has called a wait method on this object. (Inherited from Object.)

notifyAll

Releases a lock on the object that was issued by a 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.)

parmCurrentBatch

Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)

parmId

Gets or sets the Id parameter.

parmIdSynched

Gets or sets the IdSynched parameter.

parmInBatch

Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)

parmProgress

Gets or sets the Progress parameter. (Inherited from RunBase.)

parmsourceTable

Gets or sets the sourceTable parameter.

parmSysSign

Gets or sets the SysSign parameter. (Inherited from RunBase.)

parmTable2Update

Gets or sets the Table2Update parameter.

printerSettingsFormletter

printFormLetter

printJournal

printMgmtDocumentType

Identifies the print management document type.

printMgmtNodeType

Identifies the print management node type.

printout

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 class’s dialog and awaits user input. (Inherited from RunBaseBatch.)

promptChooseLines

Executes the prompt of the chooseLines query on the client side if the class is currently running on the server.

promptPack

(Inherited from RunBaseBatch.)

promptPrim

Contains the code for the prompt functionality. The RunBase.prompt Method simply wraps this method. (Inherited from RunBase.)

promptUnpack

(Inherited from RunBaseBatch.)

purchSalesDocumentStatus

putToDialog

Enables setting the fields that were just added in the RunBase.dialog Method. This method is called from the RunBase.promptPrim Method directly following the RunBase.dialogMake Method. (Inherited from RunBase.)

queryChooseLines

queryRun

Returns the QueryRun, which is used by the QueryPrompt. (Inherited from RunBase.)

reArrangeNow

removeJournalFromList

removeProforma

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.)

runsImpersonated

Overridden. Indicates whether the FormLetter class can be used in the enhanced batch framework.

saveLast

(Inherited from RunBaseBatch.)

selectFromJournal

selectFromJournalLines

Updates document lines based on the specified records.

setGetLastCalled

Sets the internal inGetSaveLast variable. (Inherited from RunBase.)

setInPrompt

Sets the internal inPrompt variable. (Inherited from RunBase.)

setIsSwappedFromServer

Sets the internal isSwappedFromServer variable. (Inherited from RunBase.)

setJournalList

Sets the journalList variable that is used by the FormLetter class.

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. 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. 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. If you change the return value to true, the button will be added. (Inherited from RunBase.)

splitDeliveryInformation

sysSignFieldId

(Inherited from RunBase.)

sysSignTableId

(Inherited from RunBase.)

sysSignValidateEmployee

(Inherited from RunBase.)

tax

tmpTaxWorkTrans

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.)

updateNow

updateParmTableWithErrors

Updates the current ParmTable table record with the provided LogText.

updatePrinterSettingsFormLetter

usageCount

Returns the current number of references (the value of the reference counter) that the object has. (Inherited from Object.)

usePrintManagement

validate

Overridden. Validates if it is okay to continue.

validateAll

wait

Pauses a process. (Inherited from Object.)

writeJournal

writeJournalLine

writeRecordListInventReportDimHistory

writeTmpTaxWorkTrans

xml

Returns an XML string that represents the current object. (Inherited from Object.)

::companyLogo

::createJournalListCopy

::descriptionHeight

::getFormRecord

::getTableRef

::inventDimReport

::inventDimReportString

::isAOSPrinter

Verifies whether a selected printer is an Application Object Server (AOS) configured printer.

::journalExternalItemId

::journalItemId

::newClientArgs

::promptChooseLinesOnClient