Knowledge::Action

DFWACTS - Actions as Functions

Parameters

Returns/Result

Examples

Reference

*************************************************************************

File Name: DFWACTS.TXT

Description: Description for DFW Action CDFs

Author: Van Dillon

*************************************************************************

Function Name Parameters Notes

NewForm

NewMenu

NewReport

NewProcedure

DocumentOpen DocName

OpenForm FormName

OpenMenu MenuName

OpenReport ReportName

OpenProcedure ProcName

DocumentClose DocName

DocumentDelete DocName In DFW 5.13 only

PrintDocument

PrintPreview

PrinterSetup

DataImport ImportName

DataExport

DesignerView

ApplicationClose

ExitDataEase

UndoEdit

CutSelected

CopySelected

CopyRecord

CopySpecial

Paste

FieldClear

FormClear

RecordSave

RecordSaveNew

RecordDelete

RecordRestore

OLELinks

AccessAllRecords

AccessReadOnly

AccessNoRecord

RefreshScreen

RefreshContinuously

RefreshSetTime

ViewAsForm

ViewAsTable

FilterClear

FilterSet

ZoomNormal

ZoomIn

ZoomOut

ZoomFillWindow

ZoomFillAcross

ZoomFillDown

ZoomPrevious

ZoomCustom

ZoomTo Percent

ZoomBy Percent

ToggleToolbar Switch

ToggleStatusbar Switch

ToggleCatalog Switch

ToggleSQL Switch

RecordFirst

RecordPrevious

RecordNext

RecordLast

FormOpenRelated TableName, [DocName]

ReturnToParentDoc

LookupTo TableName

ReturnDataToDoc

RecordPreviousPage

RecordNextPage

EndPrintToWindow

RecordFirstPos

RecordPreviousPos

RecordNextPos

RecordLastPos

RecordPrevPagePos

RecordNextPagePos

SelectRecords

RecordsSort

SortAscending

SortDescending

SelectionFilter FilterLSide, FilterRSide

QBM_NewReport

ClearQueryFilters

ClearSort

AddFilterAND FilterLSide, FilterRSide

AddFilterOR FilterLSide, FilterRSide

RunModellator

ClearSelectionFilter

Users

Relationships

CustomFunctions

DatabaseLinks

FormReorganize TableName

ApplicationBackup

ApplicationRestore

ApplicationInstall InstallName Currently not used

ApplicationLock

ApplicationUnlock

RecordsInfo

ServersInfon

DocumentsInfo

ImportsInfo

AppPreferences

WindowsTileAcross

WindowsTileDown

WindowsCascade

WindowsArrangeIcons

WindowsCloseAll

HelpIndex

HelpDesktop

HelpMenus

HelpToolbar

HelpHowTo

HelpGlossary

HelpUser

HelpAbout

HelpSearch KeyWord

HelpDQL

ExecuteFile FileName

AppRename

AppNew

AppOpen

AppDelete

AppMigrate

DOSMainMenu

DOSUserMenu MenuName

DOSRecordEntry FormName

DOSQueryMenu

DOSProcedure ProcName

DOSStatus

DOSUtilMenu

DOSImportMenu

DOSProgramCall ProgramName

DOSFormsMenu

DOSRecordsMenu

DOSMaintMenu

DOSReportsMenu

DOSDefineTable

DOSDefineForm

DOSViewForm

DOSDeleteForm

DOSOSMenu

DOSFileList FileSpec

DOSCheckDisk

DOSFormatDisk DiskDrive

DOSBackup DiskDrive

DOSRestore DiskDrive

DOSPrompt

DOSAdminMenu

DOSRunProcedure

DOSLoadProcedure

DOSDeleteProcedure

DOSRunReport

DOSReportRecords

DOSReportFields

DOSReportFormat

DOSLoadReport

DOSDeleteReport

DOSOneTimeImport

DOSRunImport ImportName

DOSDefineImport

DOSViewImport ImportName

DOSDeleteImport ImportName

DOSInstallForm

DOSInstallProcedure

MaxWin

MinWin

NormalizeWin UseSize, XPos, YPos, XSize, YSize

IfMaxNormalize UseSize, XPos, YPos, XSize, YSize

IfNormalMax

ToggleNormalMax UseSize, XPos, YPos, XSize, YSize

IfMaxMin

IfNormalMin

IsWinMax

HideWin

IfMaxHide

IfNormalHide

*************************************************************************

Function Name: NewForm

Function Description: Displays the New Document dialog with Form

selected

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: The New Document dialog is displayed with Form selected.

Notes:

DFW Action(s): New Form

*************************************************************************

Function Name: NewMenu

Function Description: Displays the New Document dialog with Menu

selected

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: The New Document dialog is displayed with Menu selected.

Notes:

DFW Action(s): New Menu

*************************************************************************

Function Name: NewReport

Function Description: Displays the New Document dialog with Report

selected

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: The New Document dialog is displayed with Report selected.

Notes:

DFW Action(s): New Report

*************************************************************************

Function Name: NewProcedure

Function Description: Displays the New Document dialog with Procedure

selected

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: The New Document dialog is displayed with Procedure selected.

Notes:

DFW Action(s): New Procedure

*************************************************************************

Function Name: QBM_NewReport

Function Description: Displays the QBM dialog with the MultiView for

the current document.

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: The QBM dialog is displayed with a copy of the MultiView for the

current document.

Notes:

DFW Action(s): QBM - New Report

*************************************************************************

Function Name: DocumentOpen

Function Description: opens specified document

Incoming Arguments: Arguments Data Type

DocName string

Return Value: status int

Usage: If DocName is not empty the specified document will be

opened. If DocName is empty then a dialog will display

with all documents.

Notes:

DFW Action(s): Document Open -- Enter: Document Name

*************************************************************************

Function Name: OpenForm

Function Description: open specified form or displays dialog

Incoming Arguments: Arguments Data Type

FormName string

Return Value: status int

Usage: If FormName is not empty the specified document will be

opened. If FormName is empty then a dialog will display

with all documents.

Notes:

DFW Action(s): Open Form -- Enter: Form Name

*************************************************************************

Function Name: OpenMenu

Function Description: open specified menu or displays dialog

Incoming Arguments: Arguments Data Type

MenuName string

Return Value: status int

Usage: If MenuName is not empty the specified document will be

opened. If MenuName is empty then a dialog will display

with all documents.

Notes:

DFW Action(s): Open Menu -- Enter: Menu Name

*************************************************************************

Function Name: OpenReport

Function Description: open specified report or displays dialog

Incoming Arguments: Arguments Data Type

ReportName string

Return Value: status int

Usage: If ReportName is not empty the specified document will be

opened. If ReportName is empty then a dialog will display

with all documents.

Notes:

DFW Action(s): Open Report -- Enter: Report Name

*************************************************************************

Function Name: OpenProcedure

Function Description: open specified procedure or displays dialog

Incoming Arguments: Arguments Data Type

ProcedureName string

Return Value: status int

Usage: If ProcedureName is not empty the specified document will be

opened. If ProcedureName is empty then a dialog will display

with all documents.

Notes:

DFW Action(s): Open Procedure -- Enter: Procedure Name

*************************************************************************

Function Name: DocumentClose

Function Description: Closes the current document

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Closes the current document.

Notes: Could be enhanced to close a specific document.

DFW Action(s): Document Close

*************************************************************************

Function Name: DocumentDelete

Function Description: Deletes the specified document or displays the

Delte Document dialog

Incoming Arguments: Arguments Data Type

DocName string

Return Value: status int

Usage: Deletes the specified document or, if no document is specified,

displays the Delete Document dialog. If the specified document

is open it will not be deleted and the system will beep.

Notes:

DFW Action(s): Document Delete -- Enter: Document Name

*************************************************************************

Function Name: PrintDocument

Function Description: Prints current document

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Displays Print dialog or prints document depending on settings

in Print Options.

Notes: Could be enhanced to set Print options w/o displaying dialog

DFW Action(s): Print Document

*************************************************************************

Function Name: PrintPreview

Function Description: Prints current document in zoomed out mode

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Zooms out then displays Print dialog or prints document

depending on settings in Print Options.

Notes: Could be enhanced to set Print options w/o displaying dialog.

DFW Action(s): Print Preview

*************************************************************************

Function Name: PrinterSetup

Function Description: Displays printer setup dialog

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Displays Printer Setup dialog.

Notes: Could be enhanced to set Printer Setup options w/o displaying

dialog.

DFW Action(s): Printer Setup

*************************************************************************

Function Name: DataImport

Function Description: Imports data

Incoming Arguments: Arguments Data Type

ImportName string

Return Value: status int

Usage: Runs an import (.DBI) or displays the import dialog.

Notes:

DFW Action(s): Data Import -- Enter: Import File (.dbi) Name

*************************************************************************

Function Name: DataExport

Function Description: Exports data

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Displays the export dialog.

Notes: Could be enhanced to set Export options w/o displaying dialog.

DFW Action(s): Data Export

*************************************************************************

Function Name: DesignerView

Function Description: puts document in design mode

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Puts document into design mode.

Notes:

DFW Action(s): Designer View

*************************************************************************

Function Name: ApplicationClose

Function Description: Closes application

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Closes the current application.

Notes: Could be enhanced to close w/o dialog confirmation.

DFW Action(s): Application Close

*************************************************************************

Function Name: ExitDataEase

Function Description: Closes DFW

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Closes DFW.EXE.

Notes: Could be enhanced to exit w/o dialog confirmation.

DFW Action(s): Exit DataEase

*************************************************************************

Function Name: UndoEdit

Function Description: undo last action

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Undoes the last edit action.

Notes:

DFW Action(s): Undo

*************************************************************************

Function Name: CutSelected

Function Description: deletes selected data to clipboard

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Cut the selected object to the clipboard.

Notes: Could be enhanced to cut from a specified field.

DFW Action(s): Cut

*************************************************************************

Function Name: CopySelected

Function Description: copies selected data to clipboard

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Copy the selected object to the clipboard.

Notes: Could be enhanced to copy from a specified field.

DFW Action(s): Copy

*************************************************************************

Function Name: CopyRecord

Function Description: copies selected record(s)

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Copy the selected record to the clipboard.

Notes:

DFW Action(s): Copy Record(s)

*************************************************************************

Function Name: CopySpecial

Function Description: copies selected data values to the clipboard

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Copy the selected record(s) data to the clipboard.

Notes: Could be enhanced to set Copy Special options w/o displaying

the dialog.

DFW Action(s): Copy Special

*************************************************************************

Function Name: Paste

Function Description: pastes data from the clipboard

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Paste data values from the clipboard.

Notes: Could be enhanced to paste data to a specified field.

DFW Action(s): Paste

*************************************************************************

Function Name: FieldClear

Function Description: Clears current field

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Currently does nothing for fields or buttons.

Notes: Could be enhanced to clear a specific field.

DFW Action(s): Field Clear

*************************************************************************

Function Name: FormClear

Function Description: Goes to a new record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Clears the form.

Notes:

DFW Action(s): Form Clear

*************************************************************************

Function Name: RecordSave

Function Description: Saves changed record(s)

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Saves modifications to the current record.

Notes:

DFW Action(s): Record Save

*************************************************************************

Function Name: RecordSaveNew

Function Description: Saves new record(s)

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Saves current record as a new record.

Notes:

DFW Action(s): Record Save As New

*************************************************************************

Function Name: RecordDelete

Function Description: Deletes current record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Deletes the current record.

Notes: Could be enhanced to set Delete options w/o displaying dialog.

DFW Action(s): Record Delete

*************************************************************************

Function Name: RecordRestore

Function Description: Rstores deleted record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Restores the current record.

Notes:

DFW Action(s): Record Restore

*************************************************************************

Function Name: OLELinks

Function Description: view, update, open, or remove OLE links.

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: view, update, open, or remove OLE links.

Notes:

DFW Action(s): Links

*************************************************************************

Function Name: AcsessAllRecords

Function Description: set locking to all record access

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Allow All Records to be Accessed by other users.

Notes:

DFW Action(s): Access All Records

*************************************************************************

Function Name: AcsessReadOnly

Function Description: set locking to read record access

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Allow other users to Read all Records.

Notes:

DFW Action(s): Access Read Only

*************************************************************************

Function Name: AcsessNoRecord

Function Description: set locking to no record access

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Allow No Records to be Accessed by other users.

Notes:

DFW Action(s): Access No Record

*************************************************************************

Function Name: RefreshScreen

Function Description: refreshes data

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Refresh the screen to show data changed by other users.

Notes:

DFW Action(s): Refresh Screen

*************************************************************************

Function Name: RefreshContinuously

Function Description: continuously refreshes data

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Continuously Refresh the screen to show data changed by other

users.

Notes:

DFW Action(s): Refresh Continuously

*************************************************************************

Function Name: RefreshSetTime

Function Description: sets refresh time

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Set the Time interval for continuous Refresh in seconds.

Notes: Current action does not accept a Time parameter.

DFW Action(s): Refresh Set Time

*************************************************************************

Function Name: ViewAsForm

Function Description: view as a form

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Set document to be displayed in single record format.

Notes:

DFW Action(s): View As a Forn

*************************************************************************

Function Name: ViewAsTable

Function Description: view as table

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Display multiple records in a tabular format.

Notes:

DFW Action(s): View As Table

*************************************************************************

Function Name: FilterClear

Function Description: filter clear

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Display all records regardless of selection filter/sort order.

Notes:

DFW Action(s): Filter Clear

*************************************************************************

Function Name: FilterSet

Function Description: set filters/sorts

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Display records according to the specified selection filter/sort

order.

Notes:

DFW Action(s): Filter Set

*************************************************************************

Function Name: ZoomNormal

Function Description: turns zoom off

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Restore display of objects to normal size.

Notes:

DFW Action(s): Zoom Normal

*************************************************************************

Function Name: ZoomIn

Function Description: zoom in

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Enlarge display of objects by %d percent of current size.

Notes:

DFW Action(s): Zoom In

*************************************************************************

Function Name: ZoomOut

Function Description: zooms out

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Reduce display of objects by a percent of current size.

Notes:

DFW Action(s): Zoom Out

*************************************************************************

Function Name: ZoomFillWindow

Function Description: zooms to fill window

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Zoom to fill the Document window.

Notes:

DFW Action(s): Zoom Fill Window

*************************************************************************

Function Name: ZoomFillAcross

Function Description: zooms to fill window width

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Zoom to fill the Width of the Document window.

Notes:

DFW Action(s): Zoom Fill Across

*************************************************************************

Function Name: ZoomFillDown

Function Description: zooms to window height

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Zoom to fill the Height of the Document window.

Notes:

DFW Action(s): Zoom Fill Down

*************************************************************************

Function Name: ZoomPrevious

Function Description: zoom to previous setting

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Restore display of objects to Previous Zoomed size.

Notes:

DFW Action(s): Zoom Previous

*************************************************************************

Function Name: ZoomCustom

Function Description: opens Custom Zoom dialog

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Use Custom Zoom dialog to specify a percentage and/or set

options.

Notes:

DFW Action(s): Zoom Custom

*************************************************************************

Function Name: ZoomTo

Function Description: zooms to specified percentage

Incoming Arguments: Arguments Data Type

ZoomTo string

Return Value: status int

Usage: Specify a percentage of the NORMAL size and Zoom TO it.

Notes:

DFW Action(s): Zoom To -- Enter: Percentage to Zoom To

*************************************************************************

Function Name: ZoomBy

Function Description: zoom by specified percentage

Incoming Arguments: Arguments Data Type

ZoomBy string

Return Value: status int

Usage: Specify a percentage of the NORMAL size and Zoom TO it.

Notes:

DFW Action(s): Zoom By -- Enter: Percentage to Zoom By

*************************************************************************

Function Name: ToggleToolbar

Function Description: toolbar on/off

Incoming Arguments: Arguments Data Type

Switch string

Return Value: status int

Usage: Show (1) or hide (0) the toolbar. If no Switch then it

toggles the setting.

Notes:

DFW Action(s): Toggle Toolbar -- Enter: 1 (set ON) or 0 (set OFF)

*************************************************************************

Function Name: ToggleStatusbar

Function Description: status bar on/off

Incoming Arguments: Arguments Data Type

Switch string

Return Value: status int

Usage: Show (1) or hide (0) the statusbar. If no Switch then it

toggles the setting.

Notes:

DFW Action(s): Toggle Status Bar -- Enter: 1 (set ON) or 0 (set OFF)

*************************************************************************

Function Name: ToggleCatalog

Function Description: catalog on/off

Incoming Arguments: Arguments Data Type

Switch string

Return Value: status int

Usage: Show (1) or hide (0) the catalog. If no Switch then it

toggles the setting.

Notes:

DFW Action(s): Toggle Catalog -- Enter: 1 (set ON) or 0 (set OFF)

*************************************************************************

Function Name: ToggleSQL

Function Description: Generated SQL window on/off

Incoming Arguments: Arguments Data Type

Switch string

Return Value: status int

Usage: Show (1) or hide (0) the SQL window. If no Switch then it

toggles the setting.

Notes:

DFW Action(s): Toggle Generated SQL -- Enter: 1 (set ON) or 0 (set OFF)

*************************************************************************

Function Name: RecordFirst

Function Description: Goes to the first record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Goes to the first record.

Notes:

DFW Action(s): Record First

*************************************************************************

Function Name: RecordPrevious

Function Description: Goes to the previous record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Goes to the previous record

Notes: Could be enhanced with a timer or to goto a specific record.

DFW Action(s): Record Previous

*************************************************************************

Function Name: NextRecord

Function Description: Goes to the next record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Goes to the next record

Notes: Could be enhanced with a timer or to goto a specific record.

DFW Action(s): Record Next

*************************************************************************

Function Name: RecordLast

Function Description: Goes to the last record

Incoming Arguments: Arguments Data Type

None

Return Value: status int

Usage: Goes to the last record.

Notes:

DFW Action(s): Record Last

*************************************************************************

Function Name: FormOpenRelated

Function Description: Opens related document

Incoming Arguments: Arguments Data Type

DocName string

Return Value: status int

Usage: If DocName is specified it is opened (assuming it is related

to the parent document). If DocName is empty then the Open

Related dialog is displayed.

Notes:

DFW Action(s): Form Open Related -- Enter RELATION[,Form]:

*************************************************************************

**************************

Knowledge::Action

Parameters

Returns/Result

Examples

Reference

See Also

On the forum about DFWACTS - Actions as Functions

On the blog about DFWACTS - Actions as Functions