PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
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(<Control or window name> , <Action to perform>)
<Result>: Boolean
Value that can be exploited only if the aafClosingDialog constant is used. This allows you to identify the action performed by the user when the dialog box is displayed. <Result> is set to:
  • False if the user asks not to close the document,
  • True otherwise.
<Control or window name>: Character string
Name of the control or window affected by the automatic feature. It is also possible to use a window alias name.
<Action to perform>: Integer constant
Automatic feature to perform. This action depends on the element used (control or window). In the case of a control, 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.
aaf1stFocusControlSets the control that will have initial focus when the window is opened.

Affected element: Edit control
aafDisplayPercentageEvolutionPvtDisplays the evolution as a percentage in a comparison in a Pivot Table control.

Affected element: Pivot Table control
aafDisplayEvolutionPvtDisplays the evolution in a comparison in a Pivot Table control.

Affected element: Pivot Table control
aafOgiAddAptAdds a new appointment into the current Organizer control. The Organizer control becomes editable in order for the user to type the appointment title.

Affected element: Organizer control
aafOgiEditAptEdits 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.

Affected element: Organizer control
aafOrgEditAptContentEdits the content of an appointment in the current Organizer control. The Organizer control goes into edit mode to allow the user to modify the content of the appointment. The "Entry in edit in an appointment" event associated with the Organizer control is executed.

Affected element: Organizer control
aafOgiDeleteAptDeletes the current appointment from the Organizer control used. The "Deleting an appointment" event of the Organizer control is executed.

Affected element: Organizer control
aafAdjustAllColumnsResizes all columns of a Table control to fit the content.

Affected element: Table control
aafCancelCompareDateRangePvtCancels the date range comparison in a Pivot Table control.

Affected element: Pivot Table control
aafCancelInputFuncUsed to define the action of a "Cancel" button found in a custom formula input bar of a Spreadsheet control. For more details, see Customizing the formula bar (Spreadsheet control).

Affected element: Button control
aafGotoLineDisplays a window allowing the user to type the number of the line to reach in the multiline edit control.

Affected element: Multiline edit control
aafRTFToolbarDisplays the enrichment bar of an RTF edit control.

Affected element: RTF edit control
aafCalculatorDisplays a popup window containing a calculator used to perform calculations.

Affected element: Numeric or Currency edit control
aafCalendarDisplays a popup window containing a calendar used to select a date.

Affected element: Date edit control
aafCheckAllChecks all rows in a Check Box column of a Table control.

Affected element: Check Box column in a Table or TreeView Table control
aafColumnAddCountAdds an automatic "Count" calculation into a column of a Table control.

Affected element: Column of Table control
aafColumnAddMaximumAdds an automatic "Maximum" calculation into a column of a Table control.

Affected element: Column of Table control
aafColumnAddMinimumAdds an automatic "Minimum" calculation into a column of a Table control.

Affected element: Column of Table control
aafColumnAddAverageAdds an automatic "Mean" calculation into a column of a Table control.

Affected element: Column of Table control
aafColumnAddTotalAdds an automatic "Total" calculation into a column of a Table control.

Affected element: Column of Table control
aafCompareDateRangePvtOpens the window for comparing date ranges in the Pivot Table control.

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

Affected element: Edit control
aafUncheckAllUnchecks all rows in a Check Box column of a Table control.

Affected element: Check Box column in a Table or TreeView Table control
aafDiscoverAAFDisplays a toast to inform the user about AAFs (Automatic Application Features).

Affected element: Window
aafClosingDialogDisplays 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 the dialog box is displayed. <Result> is set to False if the user asks not to close the document, True otherwise.

Affected element:
  • a Spreadsheet control,
  • a Word Processing control,
  • an Image Editor control.
aafSaveAsSaves the content:
  • of a Spreadsheet control in an xlsx file.
  • of a Dashboard control in image format.

Affected element:
  • Spreadsheet control
  • Dashboard control
aafSendFileByEmailSends 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.

Affected element: File path Edit control
aafExportNoteForces 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.

Affected element: Window and Note control
aafGanttAddTaskAdds 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.

Affected element: Gantt Chart column into a Table or TreeView Table control
aafGanttEditTaskEdits 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.

Affected element: Gantt Chart column into a Table or TreeView Table control
aafGanttDeleteTaskDeletes the task from the current Gantt Chart column. The process for task deletion associated with the Gantt Chart column is run.

Affected element: Gantt Chart column into a Table or TreeView Table control
aafChartDisplays the automatic chart of a Table control.

Affected element: Table control
aafImageEditModeStarts the image editor and opens the image found in the Image control in the image editor.

Affected element: Image control
aafImportNoteForces 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.

Affected element: Window and Note control
aafPrintReportOnTablePrints the report associated with the Table control if it exists or proposes to start "Reports & Queries".

Affected element: Table control
aafPrintOrganizerPrints the content of the specified Organizer control. The Organizer control print options window opens.

Affected element: Organizer control
New in version 28
aafPrintDiagram
Prints the contents of the specified Diagram Editor control. The Diagram Editor control print options window opens.

Affected element: Diagram Editor control
aafPrintFilePrints the file whose path is found in the edit control.

Affected element: File path Edit control
aafPrintHtmlPrints the content of the HTML Editor control. The report viewer opens.

Affected element: HTML Editor control
aafPrintSchedulePrints the content of the specified Scheduler control. The Scheduler control print options window opens.

Affected element: Scheduler control
aafPrintSpreadsheetPrints the content of the specified Spreadsheet control. The Spreadsheet control print options window opens.

Affected element: Spreadsheet control
aafPrintPvtPrints the content of the specified Pivot Table control. The Pivot Table control print options window opens.

Affected element: Pivot Table control
aafPrintWordProcessingPrints the content of the specified Word Processing control. The Word Processing control print options window opens.

Affected element: Word Processing control
aafCheckBoxCheckAllChecks all the options found in a Check Box control.

Affected element: Check Box control
aafOpenOpens the file whose path is found in the edit control. The software associated with the file extension is used.

Affected element: File path Edit control
aafOpenWithOpens the file whose path is found in the edit control. The user can choose the software that will be used to open the file.

Affected element: File path Edit control
aafOpenLocationOpens the directory containing the file whose path is found in the edit control.

Affected element: File path Edit control
aafPDFDeleteCurrentPageRemoves the current page from a PDF Reader control.

Affected element: PDF Reader control.
aafSchAddAptAdds 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.

Affected element: Scheduler control
aafSchEditAptEdits 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.

Affected element: Scheduler control
aafSchDeleteAptDeletes the current appointment from the Scheduler control used. The process for appointment deletion associated with the Scheduler control is run.

Affected element: Scheduler control
aafFindStarts the search (only available for multiline edit controls).

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

Affected element: Window
aafSaveBreakStatusSaves the status of breaks (expanded, collapsed, ...) in the current control (Table or Looper).

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

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
aafSpreadsheetMergeMerges the cells currently selected in a Spreadsheet control.

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

Affected element: Table control
aafTableToWordExports the Table control content or content selection to Excel or to OpenOffice Calc (depending on the software installed on the user's computer).

Affected element: Table control
aafTableToXMLExports the content of Table control or the selection performed in the Table control to XML.

Affected element: Table control
aafDashRestoreConfigRestores the initial configuration of a Dashboard control (equivalent to the "Restore initial configuration" option in modification mode).

Affected element: Dashboard control
aafPvtReverseRowColumnReverses the rows and the columns in a Pivot Table control.

Affected element: Pivot Table control
aafPvtEditModeReorganizes the row and column headers in a Pivot Table control.

Affected element: Pivot Table control
aafValidateInputFuncUsed to define the action of a "Validate" button found in a custom formula input bar of a Spreadsheet control.
For more details, see Customizing the formula bar (Spreadsheet control).

Affected element: Button control
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.
  • Used to cancel the zoom in a window that was zoomed by the user (via Ctrl + Mouse wheel).
    Affected element: Window.
Remarks
  • To disable an automatic feature, use AAFDisable. The corresponding option is automatically deleted in the context menu.
  • To delete the options that correspond to AAFs in the context menu of a control, use ContextMenu.
Business / UI classification: UI Code
Component: wd280.dll
Minimum version required
  • Version 21
This page is also available for…
Comments
Click [Add] to post a comment