GanttClient Class [AX 2012]

  • Article

The GanttClient class implements the base functionality for controlling a Gantt chart.

Syntax

class GanttClient extends RunBase

Run On

Client

Methods

  Method Description
Gg725543.pubmethod(en-us,AX.60).gif addLoadIds
Gg725543.pubmethod(en-us,AX.60).gif addLoadIdsFromDS
Gg725543.pubmethod(en-us,AX.60).gif adjustOrderDatesInterval
Gg725543.protmethod(en-us,AX.60).gif calcProgressTotal
Gg725543.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif canClose
Gg725543.pubmethod(en-us,AX.60).gif canGoBatch Returns false in this class. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif canReload
Gg725543.protmethod(en-us,AX.60).gif canSwapBetweenCS Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif canUndo
Gg725543.pubmethod(en-us,AX.60).gif caption Returns the description from the current class by calling the static description method on the class if there is one. (Overrides the caption Method.)
Gg725543.protmethod(en-us,AX.60).gif captionMain
Gg725543.pubmethod(en-us,AX.60).gif captionPrintTitle Returns the title of the Gantt chart.
Gg725543.protmethod(en-us,AX.60).gif captionPrompt
Gg725543.pubmethod(en-us,AX.60).gif checkCloseDialog Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif checkConfigurationKeyEnabled
Gg725543.pubmethod(en-us,AX.60).gif checkDatesInterval
Gg725543.pubmethod(en-us,AX.60).gif cleanAll
Gg725543.protmethod(en-us,AX.60).gif cleanAllGanttData
Gg725543.protmethod(en-us,AX.60).gif cleanAllGanttVisualization
Gg725543.protmethod(en-us,AX.60).gif cleanupDialog Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif close
Gg725543.protmethod(en-us,AX.60).gif createGanttColor
Gg725543.protmethod(en-us,AX.60).gif createGanttData
Gg725543.protmethod(en-us,AX.60).gif createGanttSetup
Gg725543.protmethod(en-us,AX.60).gif createGanttView
Gg725543.protmethod(en-us,AX.60).gif createGanttVisualization
Gg725543.protmethod(en-us,AX.60).gif dialog Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogClear Clears the contents of the dialog box. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogInit Initializes the dialog box. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif dialogInternal (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogMake Obtains the dialog from a RunBase class. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif dialogPost Makes it possible to add controls after the main dialog method has been run because this method is called after the dialog method is called. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif dialogPostInit Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogPostRun Called after the Dialog.run Method class. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif dialogReInit Reinitializes the dialog box. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogSelectCtrl When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogTask When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogUpdate Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif dialogUpdateQuery Updates the query in the dialog box. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif getFromDialog Assigns the dialog values to the internal variables. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif getInfologPrefix Gets the Infolog prefix for the current gantt client.
Gg725543.pubmethod(en-us,AX.60).gif getLast Gets the last choice that is stored in the last value table. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif getRunBase (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg725543.protmethod(en-us,AX.60).gif inGetSaveLast Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif init (Overrides the init Method.)
Gg725543.protmethod(en-us,AX.60).gif initGanttColor
Gg725543.protmethod(en-us,AX.60).gif initGanttData
Gg725543.protmethod(en-us,AX.60).gif initGanttSetup
Gg725543.protmethod(en-us,AX.60).gif initGanttView
Gg725543.protmethod(en-us,AX.60).gif initGanttVisualization
Gg725543.protmethod(en-us,AX.60).gif initOrderDates
Gg725543.pubmethod(en-us,AX.60).gif initParmDefault Initializes the internal variables. (Overrides the initParmDefault Method.)
Gg725543.pubmethod(en-us,AX.60).gif isFirstLoad
Gg725543.pubmethod(en-us,AX.60).gif isSwappingPrompt Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif lastValueDataAreaId (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif lastValueDesignName (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif lastValueElementName (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif lastValueType (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif lastValueUserId (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif load
Gg725543.protmethod(en-us,AX.60).gif loadGanttData
Gg725543.protmethod(en-us,AX.60).gif loadGanttVisualization
Gg725543.pubmethod(en-us,AX.60).gif mustLoadSaveQuery Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif name Returns the name of the RunBase class. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif new Initializes a new instance of the GanttClient class. (Overrides the new Method.)
Gg725543.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg725543.protmethod(en-us,AX.60).gif orderDatesDefaultInterval
Gg725543.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif pack Serializes the current instance of the GanttClient class. (Overrides the pack Method.)
Gg725543.pubmethod(en-us,AX.60).gif parmFromDate Gets or sets the FromDate parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmGanttColor Gets or sets the GanttColor parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmGanttData Gets or sets the GanttData parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmGanttSetup Gets or sets the GanttSetup parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmGanttView Gets or sets the GanttView parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmGanttVisualization Gets or sets the GanttVisualization parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmIsTimeScaleIntervalModified Gets or sets the IsTimeScaleIntervalModified parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmOrderFromDate Gets or sets the OrderFromDate parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmOrderToDate Gets or sets the OrderToDate parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmProgress Gets or sets the Progress parameter. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif parmSetLoadIds Gets or sets the SetLoadIds parameter.
Gg725543.pubmethod(en-us,AX.60).gif parmToDate Gets or sets the ToDate parameter.
Gg725543.protmethod(en-us,AX.60).gif postLoad
Gg725543.protmethod(en-us,AX.60).gif prepareForRun Allows subclasses to process the dialog box immediately before the dialog box.Run method. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif prepareReload
Gg725543.pubmethod(en-us,AX.60).gif progressFinish
Gg725543.pubmethod(en-us,AX.60).gif progressHide Hides the Progress form. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif progressInit (Overrides the progressInit Method.)
Gg725543.pubmethod(en-us,AX.60).gif progressInitLoading
Gg725543.pubmethod(en-us,AX.60).gif progressKill Kills the Progress object in RunBase. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif progressTotal
Gg725543.pubmethod(en-us,AX.60).gif progressUpdate
Gg725543.pubmethod(en-us,AX.60).gif prompt (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif promptPack Wraps a call to the RunBase.pack Method method when packing in the RunBase.promptPrim Method method. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif promptUnpack Unpacks what the promptPack method has packed. (Inherited from RunBase.)
Gg725543.protmethod(en-us,AX.60).gif 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.)
Gg725543.pubmethod(en-us,AX.60).gif queryRun Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif refreshVisualization
Gg725543.pubmethod(en-us,AX.60).gif reload Triggers a reload of the data in the Gantt chart.
Gg725543.pubmethod(en-us,AX.60).gif reset Resets the class to its default state. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif resetTimeScaleInterval
Gg725543.pubmethod(en-us,AX.60).gif run Contains the code that does the actual job of the class. (Overrides the run Method.)
Gg725543.pubmethod(en-us,AX.60).gif runBase Returns the RunBase itself. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif runBaseDialogModifyType_RU (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif save
Gg725543.protmethod(en-us,AX.60).gif saveGanttData
Gg725543.pubmethod(en-us,AX.60).gif saveLast Saves the last choice by using the RunBase.pack Method method. (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif setTimeScaleInterval
Gg725543.protmethod(en-us,AX.60).gif 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.)
Gg725543.pubmethod(en-us,AX.60).gif 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.)
Gg725543.pubmethod(en-us,AX.60).gif showDialog (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif 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.)
Gg725543.protmethod(en-us,AX.60).gif showProgress
Gg725543.pubmethod(en-us,AX.60).gif showQuerySelectButton (Inherited from RunBase.)
Gg725543.pubmethod(en-us,AX.60).gif 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.)
Gg725543.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif undo
Gg725543.pubmethod(en-us,AX.60).gif unpack Deserializes the packedClass parameter value to an instance of the GanttClient class. (Overrides the unpack Method.)
Gg725543.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif validate (Overrides the validate Method.)
Gg725543.pubmethod(en-us,AX.60).gif validateSave
Gg725543.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg725543.pubmethod(en-us,AX.60).gif Gg725543.static(en-us,AX.60).gif ::description Gets the description of the class.

Top

Remarks

The class provides the basic features that are needed for implementing a custom Gantt chart. These include the following:

  • Handling of Gantt chart initialization.

  • Support for data loading and saving by the usage of the Gantt data classes.

  • Basic support for data validation.

  • Basic support for configuration keys check.

  • Support for creation and usage of the Gantt color, data, setup and view classes.

  • Handling of Gantt chart loading progress display.

Inheritance Hierarchy

Object Class
  RunBase Class
    GanttClient Class
      GanttClient_ReqExplosion Class
      GanttClient_RSi Class
      GanttClient_RSMgri Class
      GanttClient_SMA Class
      GanttClient_WrkCtr Class

See Also

GanttCalendar Class

GanttColor Class

GanttSetup Class