PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Runs an Automatic Application Feature (AAF) on a control or window. This function can be used to start the spelling checker on an edit control for example.
Example
// Click the "Spelling checker" button
// => Starts the spelling checker
// on the "EDT_ProdDescription" edit control
AAFExecute(EDT_ProductDesc, aafSpellCheck)
// Click the "Cancel" button
// => restores the previous values
AAFExecute(WIN_EditCustomer, aafRestoreValue)
Syntax
<Result> = AAFExecute(<Name of Control or Window> , <Action to Perform>)
<Result>: Boolean
Versions 23 and later
Value that can be exploited only if the aafClosingDialog constant is used. This allows you to identify the action performed by the user when displaying the dialog box. <Result> is set to:
  • False if the user asks not to close the document,
  • True otherwise.
New in version 23
Value that can be exploited only if the aafClosingDialog constant is used. This allows you to identify the action performed by the user when displaying the dialog box. <Result> is set to:
  • False if the user asks not to close the document,
  • True otherwise.
Value that can be exploited only if the aafClosingDialog constant is used. This allows you to identify the action performed by the user when displaying the dialog box. <Result> is set to:
  • False if the user asks not to close the document,
  • True otherwise.
<Name of Control or Window>: Character string (with or without quotes)
Name of control or window affected by the automatic feature. You also have the ability to use a name of window alias.
<Action to Perform>: Integer constant
Automatic feature to perform. This action depends on the type of control used. The function has no effect if the type of control is not valid for the selected constant.
Versions 15 and later
aafOgiAddApt
New in version 15
aafOgiAddApt
aafOgiAddApt
Adds a new appointment into the current Organizer control. The Organizer control becomes editable in order for the user to type the appointment title. The process for appointment addition associated with the Organizer control is run.
Windows Mobile This constant is not available.

Affected element: Organizer control
Versions 15 and later
aafOgiEditApt
New in version 15
aafOgiEditApt
aafOgiEditApt
Edits an appointment in the current Organizer control. The Organizer control becomes editable on the appointment in order for the user to type the appointment title. The process for appointment edit associated with the Organizer control is run.
Windows Mobile This constant is not available.

Affected element: Organizer control
Versions 15 and later
aafOgiDeleteApt
New in version 15
aafOgiDeleteApt
aafOgiDeleteApt
Deletes the current appointment from the Organizer control used. The process for appointment deletion associated with the Organizer control is run.
Windows Mobile This constant is not available.

Affected element: Organizer control
Versions 20 and later
aafCancelFuncInput
New in version 20
aafCancelFuncInput
aafCancelFuncInput
Used to define the action of a "Cancel" button found in a custom formula input bar of a Spreadsheet control. See Customizing the formula bar (Spreadsheet control) for more details.
Windows Mobile This constant is not available.

Affected element: Button control
Versions 15 and later
aafGotoLine
New in version 15
aafGotoLine
aafGotoLine
Displays a window allowing the user to type the line number to reach in the multiline edit control.
Windows Mobile This constant is not available.

Affected element: Multiline edit control
aafRTFToolbarDisplays the enrichment bar of a RTF edit control.
Windows Mobile This constant is not available.

Affected element: RTF edit control
Versions 17 and later
aafCalculator
New in version 17
aafCalculator
aafCalculator
Displays a popup window containing a calculator used to perform calculations.
Windows Mobile This constant is not available.

Affected element: Numeric or Currency edit control
aafCalendarDisplays a popup window containing a calendar used to select a date.
Affected element: Date edit control
Versions 22 and later
aafCheckAll
New in version 22
aafCheckAll
aafCheckAll
Checks all rows in a Check Box column of a Table control.
Windows Mobile This constant is not available.

Affected element: Check Box column in a Table or TreeView Table control
Versions 16 and later
aafColumnAddCount
New in version 16
aafColumnAddCount
aafColumnAddCount
Adds an automatic "Count" calculation into a column of a Table control.
Windows Mobile This constant is not available.

Affected element: Column of Table control
Versions 22 and later
aafColumnAddMaximum
New in version 22
aafColumnAddMaximum
aafColumnAddMaximum
Adds an automatic "Maximum" calculation into a column of a Table control.
Windows Mobile This constant is not available.

Affected element: Column of Table control
Versions 22 and later
aafColumnAddMinimum
New in version 22
aafColumnAddMinimum
aafColumnAddMinimum
Adds an automatic "Minimum" calculation into a column of a Table control.
Windows Mobile This constant is not available.

Affected element: Column of Table control
Versions 16 and later
aafColumnAddAverage
New in version 16
aafColumnAddAverage
aafColumnAddAverage
Adds an automatic "Mean" calculation into a column of a Table control.
Windows Mobile This constant is not available.

Affected element: Column of Table control
Versions 16 and later
aafColumnAddTotal
New in version 16
aafColumnAddTotal
aafColumnAddTotal
Adds an automatic "Total" calculation into a column of a Table control.
Windows Mobile This constant is not available.

Affected element: Column of Table control
Versions 22 and later
aafComparePeriodPvt
New in version 22
aafComparePeriodPvt
aafComparePeriodPvt
Opens the window used to compare different periods in the Pivot Table control.
Windows Mobile This constant is not available.

Affected element: Pivot Table control
aafSpellCheckStarts the Word spelling checker on an edit control.
Note: This feature requires Word 2000 (or later) on the user computer. This feature does not operate with Word 97.
Windows Mobile This constant is not available.

Affected element: Edit control
Versions 22 and later
aafUncheckAll
New in version 22
aafUncheckAll
aafUncheckAll
Unchecks all rows in a Check Box column of a Table control.
Windows Mobile This constant is not available.

Affected element: Check Box column in a Table or TreeView Table control
Versions 23 and later
aafClosingDialog
New in version 23
aafClosingDialog
aafClosingDialog
Displays the dialog for confirming (or not) the backup of current document (see ControlExecuteClosing as well). If this constant is used, AAFExecute returns the action performed by the user when displaying the dialog box. <Result> is set to False if the user asks not to close the document, True otherwise.
Windows Mobile This constant is not available.

Affected element:
  • a Spreadsheet control,
  • a Word Processing control,
  • an Image Editor control.
Versions 20 and later
aafSaveAs
New in version 20
aafSaveAs
aafSaveAs
Saves the content:
  • of a Spreadsheet control in an xlsx file.
  • of a Dashboard control in image format.
Windows Mobile This constant is not available.

Affected element:
  • Spreadsheet control
  • Dashboard control
Versions 17 and later
aafSendFileByEmail
New in version 17
aafSendFileByEmail
aafSendFileByEmail
Sends the file whose path is found in the edit control in email attachment. The email manager found on the current computer is automatically opened, with a new email and the document in attachment.
Windows Mobile This constant is not available.

Affected element: File Path edit control
Versions 21 and later
aafExportNote
New in version 21
aafExportNote
aafExportNote
Forces the export of repositionable notes from the current window to a wdnote file. The file picker is opened and the end user must specify the name and path of file to generate.
Windows Mobile This constant is not available.

Affected element: Window and Note control
Versions 19 and later
aafGanttAddTask
New in version 19
aafGanttAddTask
aafGanttAddTask
Adds a new task into the current Gantt Chart column. The selected area becomes editable in order for the user to type the task title. The process for task addition associated with the Gantt Chart column is run.
Windows Mobile This constant is not available.

Affected element: Gantt Chart column into a Table or TreeView Table control
Versions 19 and later
aafGanttEditTask
New in version 19
aafGanttEditTask
aafGanttEditTask
Edits a task in the current Gantt Chart column. The selected task becomes editable in order for the user to modify its title. The process for task edit associated with the Gantt Chart column is run.
Windows Mobile This constant is not available.

Affected element: Gantt Chart column into a Table or TreeView Table control
Versions 19 and later
aafGanttDeleteTask
New in version 19
aafGanttDeleteTask
aafGanttDeleteTask
Deletes the task from the current Gantt Chart column. The process for task deletion associated with the Gantt Chart column is run.
Windows Mobile This constant is not available.

Affected element: Gantt Chart column into a Table or TreeView Table control
aafChartDisplays the automatic chart of a Table control.
Windows Mobile This constant is not available.

Affected element: Table control
Versions 23 and later
aafImageEditMode
New in version 23
aafImageEditMode
aafImageEditMode
Starts the image editor and opens the image found in the Image control in the image editor.
Windows Mobile This constant is not available.

Affected element: Image control
Versions 21 and later
aafImportNote
New in version 21
aafImportNote
aafImportNote
Forces the import of repositionable notes found in a wdnote file. The file picker is opened and the end user must specify the name and path of file to import.
Windows Mobile This constant is not available.

Affected element: Window and Note control
aafPrintReportOnTablePrints the report associated with the Table control if it exists or proposes to start "Reports & Queries".
Windows Mobile This constant is not available.

Affected element: Table control
Versions 17 and later
aafPrintOrganizer
New in version 17
aafPrintOrganizer
aafPrintOrganizer
Prints the content of the specified Organizer control. The window for configuring the print of Organizer control is opened.
Windows Mobile This constant is not available.

Affected element: Organizer control
Versions 17 and later
aafPrintFile
New in version 17
aafPrintFile
aafPrintFile
Prints the file whose path is found in the edit control.
Windows Mobile This constant is not available.

Affected element: File Path edit control
Versions 17 and later
aafPrintSchedule
New in version 17
aafPrintSchedule
aafPrintSchedule
Prints the content of the specified Scheduler control. The window for configuring the print of Scheduler control is opened.
Windows Mobile This constant is not available.

Affected element: Scheduler control
Versions 21 and later
aafPrintSpreadsheet
New in version 21
aafPrintSpreadsheet
aafPrintSpreadsheet
Prints the content of the specified Spreadsheet control. The window for configuring the print of Spreadsheet control is opened.
Windows Mobile This constant is not available.

Affected element: Spreadsheet control
Versions 21 and later
aafPrintPvt
New in version 21
aafPrintPvt
aafPrintPvt
Prints the content of the specified Pivot Table control. The window for configuring the print of Pivot Table control is opened.
Windows Mobile This constant is not available.

Affected element: Pivot Table control
Versions 20 and later
aafCheckBoxCheckAll
New in version 20
aafCheckBoxCheckAll
aafCheckBoxCheckAll
Checks all the options found in a Check Box control.
Windows Mobile This constant is not available.

Affected element: Check Box control
Versions 17 and later
aafOpen
New in version 17
aafOpen
aafOpen
Opens the file whose path is found in the edit control. The software associated with the file extension is used.
Windows Mobile This constant is not available.

Affected element: File Path edit control
Versions 17 and later
aafOpenWith
New in version 17
aafOpenWith
aafOpenWith
Opens the file whose path is found in the edit control. The user can choose the software that will be used to open the file.
Windows Mobile This constant is not available.

Affected element: File Path edit control
Versions 17 and later
aafOpenLocation
New in version 17
aafOpenLocation
aafOpenLocation
Opens the directory containing the file whose path is found in the edit control.
Windows Mobile This constant is not available.

Affected element: File Path edit control
Versions 16 and later
aafSchAddApt
New in version 16
aafSchAddApt
aafSchAddApt
Adds a new appointment into the current Scheduler control. The Scheduler control becomes editable in order for the user to type the appointment title. The process for appointment addition associated with the Scheduler control is run.
Caution: the day for which the appointment is created must have been selected beforehand.
Windows Mobile This constant is not available.

Affected element: Scheduler control
Versions 16 and later
aafSchEditApt
New in version 16
aafSchEditApt
aafSchEditApt
Edits an appointment in the current Scheduler control. The Scheduler control becomes editable in order for the user to modify the appointment title. The process for appointment edit associated with the Scheduler control is run.
Windows Mobile This constant is not available.

Affected element: Scheduler control
Versions 16 and later
aafSchDeleteApt
New in version 16
aafSchDeleteApt
aafSchDeleteApt
Deletes the current appointment from the Scheduler control used. The process for appointment deletion associated with the Scheduler control is run.
Windows Mobile This constant is not available.

Affected element: Scheduler control
aafFindStarts the search (only available for multiline edit controls).
Windows Mobile This constant is not available.

Affected element: Multiline edit control
aafRestoreValueRestores the previous values of persistent controls in a window.

Affected element: Window
Versions 20 and later
aafSaveBreakStatus
New in version 20
aafSaveBreakStatus
aafSaveBreakStatus
Saves the status of breaks (expanded, collapsed, ...) in the current control (Table or Looper).
Windows Mobile This constant is not available.

Affected element: Table control, Looper control
aafSaveSizeAndPositionSaves the window size and position as well as the size and position of window controls (splitter, table, toolbar).
Windows Mobile This constant is not available.

Affected element: Window
aafSaveValueSaves the values of persistent controls in a window. This AAF can be run at control level or at window level.

Affected elements: Window, edit control, list box, editable combo box, radio button or check box
Versions 20 and later
aafSpreadsheetMerge
New in version 20
aafSpreadsheetMerge
aafSpreadsheetMerge
Merges the cells currently selected in a Spreadsheet control.
Windows Mobile This constant is not available.

Affected element: Spreadsheet control
aafTableToExcelExports the content of Table control or the selection performed in the Table control to Excel or to OpenOffice Calc (depending on the software installed in the user computer).
Windows Mobile This constant is not available.

Affected element: Table control
aafTableToWordExports the content of Table control or the selection performed in the Table control to Excel or to OpenOffice Calc (depending on the software installed on the user computer).
Windows Mobile This constant is not available.

Affected element: Table control
aafTableToXMLExports the content of Table control or the selection performed in the Table control to XML.
Windows Mobile This constant is not available.

Affected element: Table control
Versions 20 and later
aafPvtReverseRowColumn
New in version 20
aafPvtReverseRowColumn
aafPvtReverseRowColumn
Reverses the rows and the columns in a Pivot Table control.
Windows Mobile This constant is not available.

Affected element: Pivot Table control
Versions 23 and later
aafDashEditMode
New in version 23
aafDashEditMode
aafDashEditMode
Reorganizes the row and column headers in a Pivot Table control.
Windows Mobile This constant is not available.

Affected element: Pivot Table control
Versions 20 and later
aafValidateFuncInput
New in version 20
aafValidateFuncInput
aafValidateFuncInput
Used to define the action of a "Validate" button found in a custom formula input bar of a Spreadsheet control.
See Customizing the formula bar (Spreadsheet control) for more details.
Windows Mobile This constant is not available.

Affected element: Button control
Versions 20 and later
aafZoom
New in version 20
aafZoom
aafZoom
  • Used to cancel the zoom that was performed by the user (via CTRL + Mouse wheel) in a Table, TreeView Table, Pivot Table, Spreadsheet or List Box control.
    Affected element: Table, TreeView Table, Pivot Table, Spreadsheet or List Box control.
  • Versions 21 and later
    Used to cancel the zoom in a window that was zoomed by the user (via CTRL + Mouse wheel).
    Affected element: Window.
    New in version 21
    Used to cancel the zoom in a window that was zoomed by the user (via CTRL + Mouse wheel).
    Affected element: Window.
    Used to cancel the zoom in a window that was zoomed by the user (via CTRL + Mouse wheel).
    Affected element: Window.
Windows Mobile This constant is not available.
Remarks
  • To disable an automatic feature, use DisableAAF. The option is automatically deleted from the corresponding popup menu.To disable an automatic feature, use AAFDisable (or DisableAAF). The option is automatically deleted from the corresponding popup menu.
  • To delete the options from the popup menu of a control corresponding to AAFs, use ..PopupMenu.
Components
WINDEVReports and Queries wd230obj.dll
Windows Mobile wp230obj.dll
Minimum required version
  • Version 21
This page is also available for…
Comments
Click [Add] to post a comment