AppFrame Core Functionality
All AppFrame Core Functions
afAccessLayer
| Shared methods/functions | Parametres | Return value | Description |
|---|---|---|---|
| ExecProcedure | ProcedureCall | DataSet | Executes a stored procedure |
| ExecProcedures | ProcedureCall() | DataSet | Executes an array of stored procedures |
| DelData | RecordSource,Primkey | Integer (Numbers of records deleted) | Deletes the specified record |
| GetData | RecordSource | DataTable | Gets the specified data from DB |
| GetDataScalar | RecordSource | Object | Gets an individual piece of data (scalar) |
| GetRecordSourceSchema | RecordSource | Datatable | Gets the schema to the specified view |
| GetReportData | ReportRecordSource,RSID | DataTable | |
| GetSchema | ViewName | Gets shcema definition | |
| AddData | Inserts data based on the your recordsource and values that's supplied | ||
| ChangePassword | Password | Changes password | |
| PutData | Updates data based on values supplied |
| Properties | Type | Description |
|---|---|---|
| MaxRecords | Integer | Gets or Sets the maxrecords to be loaded. If not set, it will use defaultValue from connection string. |
afProcedureCall
| Constructor | Parametres | Return value |
|---|---|---|
| New | ViewName | afProcedureCall |
| Properties | Type | Description |
|---|---|---|
| Parameters | afParameterCollection | Gets or sets the parameter collection for the procedure |
| ProcedureName | String | Gets or sets the procedure name |
| Timeout | Integer | Gets or sets the timeout limit when running the proc |
| UseTransaction | Boolean | Gets or sets whether the procedure should be run using begin/end transaction |
afRecordSource
| Constructor | Parametres |
|---|---|
| New | ViewName |
| New | RecordSource |
| Properties | Type | Description |
|---|---|---|
| DistinctRows | Boolean | Gets or sets whether the data should be loaded with distinct values |
| FilterString | String | Gets or sets the filterstring (initial filter) |
| MasterChildCriteria | List(Of KeyValuePair) | Gets or sets the masterchild reference |
| MaxRecords | Integer | Gets or sets the MaxRecords to be loaded |
| OrderByColumns | afOrderByColumnCollection | Gets or sets the OrderByColumn Collection |
| SelectColumns | afSelectColumnCollection | Gets or sets the SelectColumn collection |
| GroupByColumns | afGroupByColumns | Gets or sets the GroupbyColumn collection |
| ToXML | String | Gets the RecordSource object serialized as XML |
| UniqueTable | String | Gets or sets the UniqueTable name of the view |
| ViewName | String | Gets or sets the view name |
| WhereClause | String | Gets or sets the where clause |
CR3 (Common functions and methods)
| Shared Methods/Functions | Parametres | Description |
|---|---|---|
| HandleException (4 overloads) |
- Exception - Exception, WriteToLog - Message,Source - Message,Source,WriteToLog |
Method for handling exceptions. Will also log the errormessage in the database |
| OpenAppFramePage | RelativeUrl, QueryString | Method for opening an AppFrame based webpage using the credentials of the user logged into CR3 |
| OpenForm (5 Overloads) |
- ProjectName, FormName - ProjectName, FormName, OpenMode - ProjectName, FormName, FilerString - ProjectName, FormName FilterString, OpenMode - ProjectName, FormName, FilterString,OpenProperties, pTarget |
Opens a specific form |
| OpenMailMessage | MessageRef, Mode | Opens an existing mail message |
| OpenNewMailMessage | Opens a new mail message | |
| OpenReport | ReportId, Filter | Opens an report within DevEx Report Engine |
| OpenWebPage | Url | Opens a webpage |
| SaveReport | ReportId,Filter,Path, ReportFormat | Saves a report to disk |
| OpenProject | ProjectName | Opens a project |
| SetStatus | Text, ShowProgressBar, ShowLoadingDialog | Adding a temporary text to the status bar |
| Properties | Type | Description |
|---|---|---|
| MainMDIManager | ||
| MainInstance |