Table of Contents

Class Form

Namespace
PolarStudio
Assembly
PolarStudio.dll

This class represents a form as is opened for a user in a web application. This can be either a normal (bound or unbound) form or a system-form (like Polar Tools).

public class Form : PolarWeakEventListener
Inheritance
Form
Implements
Inherited Members
Extension Methods

Fields

BootstrapColumnClassPrefix

This property sets the prefix of Bootstrap grid-cells, like 'md-'

public string BootstrapColumnClassPrefix

Field Value

string

BootstrapFormRowClassesTC

This property sets the classes to use for a Bootstrap row, like 'row'

public string BootstrapFormRowClassesTC

Field Value

string

CancelCloseAction

This property only has a function during the close-event of the form. In this event, this propery can be set to true to cancel the close action that is performed.

public bool CancelCloseAction

Field Value

bool

DisabledTextBoxBackColor

This property gets/sets the html background color of disabled textboxes. Can also be done with css nowadays.

public string DisabledTextBoxBackColor

Field Value

string

ErrorCssClass

This property gets/sets the css class that is to be added to controls with errors.

public string ErrorCssClass

Field Value

string

ErrorTextBoxBackColor

This property gets/sets the html background color of controls with errors.

public string ErrorTextBoxBackColor

Field Value

string

FilterHelpTC

This property gets/sets the help text for the filter screen.

public string FilterHelpTC

Field Value

string

FormFooterPrintHtmlTC

This property gets/sets the html footer as is shown on the bottom of the form when printed.

public string FormFooterPrintHtmlTC

Field Value

string

FormFooterScreenHtmlTC

This property gets/sets the html footer as is shown on the bottom of the form when displayed on screen.

public string FormFooterScreenHtmlTC

Field Value

string

FormHeaderPrintHtmlTC

This property gets/sets the html header as is shown on top of the form when printed.

public string FormHeaderPrintHtmlTC

Field Value

string

FormHeaderScreenHtmlTC

This property gets/sets the html header as is shown on top of the form when displayed on screen.

public string FormHeaderScreenHtmlTC

Field Value

string

HelpTextTC

This property gets/sets the help text for this form.

public string HelpTextTC

Field Value

string

ListColumn_Delete

This property sets/gets if the delete column in list view is to be shown or not. The delete column contains the delete-boxes to delete records (if allowed).

public bool ListColumn_Delete

Field Value

bool

ListColumn_Notes

This property sets/gets if the notes column in list view is to be shown or not. The notes are used to show a note for a record when a delete or update failed in listview.

public bool ListColumn_Notes

Field Value

bool

ListColumn_RecordSelector

This property sets/gets if the record selector column in list view is to be shown or not. The record selector is a marker that can be shown in list view for the last record that was shown in detail view or for when navigation took place to a specific record.

public bool ListColumn_RecordSelector

Field Value

bool

ListColumn_ShowDetails

This property sets/gets if the show details column in list view is to be shown or not. The show details button is the icon/button the user can use to see the details of a record.

public bool ListColumn_ShowDetails

Field Value

bool

ListFooterPrintHtmlTC

This property gets/sets the html footer as is shown on the bottom of the list view when printed.

public string ListFooterPrintHtmlTC

Field Value

string

ListFooterScreenHtmlTC

This property gets/sets the html footer as is shown on the bottom of the list view when displayed on screen.

public string ListFooterScreenHtmlTC

Field Value

string

ListHeaderPrintHtmlTC

This property gets/sets the html header as is shown on top of the list view when printed.

public string ListHeaderPrintHtmlTC

Field Value

string

ListHeaderScreenHtmlTC

This property gets/sets the html header as is shown on top of the list view when displayed on screen.

public string ListHeaderScreenHtmlTC

Field Value

string

ListRowSpecs_Even

This property gets/sets the specs of even TR tags in list view. The value of this property is included within the TR-tag and can for example contain a class or style definition.

public string ListRowSpecs_Even

Field Value

string

ListRowSpecs_Odd

This property gets/sets the specs of odd TR tags in list view. The value of this property is included within the TR-tag and can for example contain a class or style definition.

public string ListRowSpecs_Odd

Field Value

string

NoRecordsToDisplayHTML

This property gets/sets the html to show when there are no records to show.

public string NoRecordsToDisplayHTML

Field Value

string

NoRecordsToDisplayHTML_RequireFilter

This property gets/sets the html to show when there are no records to show due to the fact that the user is required to apply a filter first.

public string NoRecordsToDisplayHTML_RequireFilter

Field Value

string

RecordSeparatorHtmlTC

This property gets/sets the separator as is shown between 2 records in continous forms view. This can for example be a '<hr>'

public string RecordSeparatorHtmlTC

Field Value

string

TableSettings

Returns the table-settings as stored in the repository for this form.

public repTable TableSettings

Field Value

repTable

TableSettingsForGroup

Returns the group-specific table setting for this form for the group the current user is part of.

public repTableSettings TableSettingsForGroup

Field Value

repTableSettings

TableTagSpecsPrint

This property gets/sets the specs of the table-tag as is created for printing a non-bootstrap form-view. The value of this property is included within the table-tag and can for example contain a class or style definition.

public string TableTagSpecsPrint

Field Value

string

TableTagSpecsPrintList

This property gets/sets the specs of the table-tag as is created for printing a list-view. The value of this property is included within the table-tag and can for example contain a class or style definition.

public string TableTagSpecsPrintList

Field Value

string

TableTagSpecsScreen

This property gets/sets the specs of the table-tag as is created for non-bootstrap form-view. For non-bootstrap, a html table is used with each control in a row / cell. This property can set the specs of this table tag. The traditional filter form also uses this property. The value of this property is included within the table-tag and can for example contain a class or style definition.

public string TableTagSpecsScreen

Field Value

string

TableTagSpecsScreenList

This property gets/sets the specs of the table-tag as is created for list-view. The value of this property is included within the table-tag and can for example contain a class or style definition.

public string TableTagSpecsScreenList

Field Value

string

UI_AlwaysShowSaveButtonIfEditAllowed

This property gets/sets the feature of always showing the save button in form view if the user is allowed to edit a record. Normally, when no editable controls are rendered, the save button is hidden. However, when using tabs and an edit is made on a different tab, this can be unclear for the user. This property will force the save button to be shown always for when the record is editable.

public bool UI_AlwaysShowSaveButtonIfEditAllowed

Field Value

bool

UI_SupportMoveFirstMoveLastInListView

This property gets/sets the feature of supporting move first/move last in list view. For some applications or forms, you may want to disable this feature.

public bool UI_SupportMoveFirstMoveLastInListView

Field Value

bool

UI_SuppressSaveButtonWhenOKvisible

This property suppresses the save button when the OK button is visible. Sometimes, both buttons can be visible (for example for a new record). When these buttons are shown on different button bars, this may not be a problem, but when the save button and OK button are next to each other on one button bar, this can be unclear for the user. This feature helps to prevent this situation.

public bool UI_SuppressSaveButtonWhenOKvisible

Field Value

bool

UI_SuppressUnusedDataElements

This property gets/sets the feature to suppress all unused data elements. These are for example the navigation buttons (move next, move first, etc), the delete and the insert button. Sometimes, when showing on record in detail, you want all unneeded elements to be hidden to clean up the user interface. All elements that have a funtion are shown nonetheless.

public bool UI_SuppressUnusedDataElements

Field Value

bool

UnboundForm_CancelRecordButtonScript

This property can be used to show the Cancel button in an unbound form and run the action as is set in this property.

public string UnboundForm_CancelRecordButtonScript

Field Value

string

UnboundForm_NavDeleteButtonScript

This property can be used to show the Delete button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavDeleteButtonScript

Field Value

string

UnboundForm_NavInsertButtonScript

This property can be used to show the Insert button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavInsertButtonScript

Field Value

string

UnboundForm_NavListSelectButtonScript

This property can be used to show the List Select (quick select) button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavListSelectButtonScript

Field Value

string

UnboundForm_NavMoveFirstButtonScript

This property can be used to show the Move First button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavMoveFirstButtonScript

Field Value

string

UnboundForm_NavMoveLastButtonScript

This property can be used to show the Move Last button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavMoveLastButtonScript

Field Value

string

UnboundForm_NavMoveNextButtonScript

This property can be used to show the Move Next button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavMoveNextButtonScript

Field Value

string

UnboundForm_NavMovePreviousButtonScript

This property can be used to show the Move Previous button in an unbound form and run the action as is set in this property.

public string UnboundForm_NavMovePreviousButtonScript

Field Value

string

UnboundForm_SaveRecordButtonScript

This property can be used to show the Save button in an unbound form and run the action as is set in this property.

public string UnboundForm_SaveRecordButtonScript

Field Value

string

UseBootstrapDesign

This property indicates that the form is to be rendered using the Bootstrap grid instead of a html table.

public bool UseBootstrapDesign

Field Value

bool

Properties

AlternatingRow

Returns True if an 'odd' or alternating row is rendered in list view. (Switches back and forward from True to False for each row that is rendered in list view)

public bool AlternatingRow { get; }

Property Value

bool

Application

Returns the (web) application this form is tied to.

public Application Application { get; }

Property Value

Application

ApplicationID

Returns the SysApplicationID for the application this form is opened for in the repository.

public int ApplicationID { get; }

Property Value

int

AvailableOrderSettings

This method returns all order settings for this form that are actually available for the current user.

public repFormOrders AvailableOrderSettings { get; }

Property Value

repFormOrders

BlobDetailsControlName

Returns the name of the blob control for which the details are shown.

public string BlobDetailsControlName { get; }

Property Value

string

BootstrapFormContainerTC

This property gets/sets the container html for a Bootstrap form. It MUST contain a [DETAILS] placeholder. This is something like '<div class='container'>[DETAILS]</div>'

public string BootstrapFormContainerTC { get; set; }

Property Value

string

BudaApplication

Returns the BudaApplication (data layer) this form is tied to.

public BudaApplication BudaApplication { get; }

Property Value

BudaApplication

BudaSession

Returns the BudaSession (data layer) this form is tied to.

public BudaSession BudaSession { get; }

Property Value

BudaSession

Buttons

The custom buttons is a collection that contains all custom buttons that are defined within polar studio and have the form as context.

public CustomButtons Buttons { get; }

Property Value

CustomButtons

CaptionTC

This property gets/sets the Caption for this form (as text code).

public string CaptionTC { get; set; }

Property Value

string

CloseFormAfterInsert

This property gets/sets the feature to automatically close the form after an insert has been completed. Is for example used for a Quick Insert Parent. This property can only be updated from True to False (to disable it) in script.

public bool CloseFormAfterInsert { get; set; }

Property Value

bool

ConfirmInsert

This property sets the behaviour of saving a new record. When ConfirmInsert is set to true, the system waits till the user clicks OK before trying to store a new record. When set to False, the system tries to store the record with every post (but will not show error messages resulting from this update, unless the user explicitly presses OK)

public bool ConfirmInsert { get; set; }

Property Value

bool

Controls

Returns all controls in the form in the order as shown and indexed by name.

public Controls Controls { get; }

Property Value

Controls

DataSet

This method returns the DataSet this form is tied to (for bound forms only)

public BudaDataSet DataSet { get; }

Property Value

BudaDataSet

DefaultBootstrapLabelWidth

This property gets/sets the default width in Bootstrap columns for labels.

public int DefaultBootstrapLabelWidth { get; set; }

Property Value

int

DeleteConfirmation

This property gets/sets if the user has to confirm a delete (are you sure to delete...) or not.

public bool DeleteConfirmation { get; set; }

Property Value

bool

DeleteConfirmationText

Returns the confirmation text the user is asked before deleting a record (when the property DeleteConfirmation = True)

public string DeleteConfirmationText { get; set; }

Property Value

string

DeleteMayBePossible

Returns True if the user could in theory delete records in this table. It is for example used to determine if the delete-boxes column is shown. If the user has no permission at all to delete, then this propery returns False. If the user has permission to delete, but maybe is not allowed to delete the current record (due to a state or DeleteAllowedScript) then still this will return True.

public bool DeleteMayBePossible { get; }

Property Value

bool

DesignTemplateFormTC

This property gets/sets the DesignTemplate as is to be used to display the form in form-view. If no design template is given (empty string) then the normal form will be rendered.

public string DesignTemplateFormTC { get; set; }

Property Value

string

DesignTemplateListEnvelopTC

This property gets/sets the DesignTemplate as is to be used as list-envelop (containing the individual records) to display the form in list-view. use '[Records]' as placeholder where the rendered records are to be included. If this property is empty, then '<table>[Records]</table>' is used.

public string DesignTemplateListEnvelopTC { get; set; }

Property Value

string

DesignTemplateListRecordTC

This property gets/sets the DesignTemplate as is to be used to display one record in list-view. If no design template is given (empty string) then the normal form will be rendered.

public string DesignTemplateListRecordTC { get; set; }

Property Value

string

EditBuffer

This method returns the EditBuffer as is used when a list view is shown. Used internally.

public IndexedCollection<EditBufferRecord> EditBuffer { get; }

Property Value

IndexedCollection<EditBufferRecord>

Engine

Returns a reference to the Engine (the datalayer) this form is tied to.

public BudaEngine Engine { get; }

Property Value

BudaEngine

FilterAllowed

Returns True if the user is allowed to filter in this table.

public bool FilterAllowed { get; }

Property Value

bool

FirstControlToActivate

This property gets/sets the full HtmlFieldName of the control to activate as first control.

public string FirstControlToActivate { get; set; }

Property Value

string

FormID

Returns the SysFormID of the form as it is defined in the Polar Studio repository. May return a negative number for system forms.

public int FormID { get; }

Property Value

int

FormInstanceID

Returns the ID (an int) of the instance of this form. This FormInstanceID is used to activate this form, etc.

public int FormInstanceID { get; }

Property Value

int

FormMode

This property gets/sets the form mode. This is one of: 'FORM', 'EDITINPROGRESS', 'ADDNEW', 'SIMPLEPRINT', 'SHOWSTATETRANSITIONS', 'STATETRANSITIONCONFIRMATION', 'FILTER', 'QUICKLIST' 'CLOSED'. When setting this property, it is only possible to switch from 'FORM' to 'EDITINPROGRESS' and back.

public string FormMode { get; set; }

Property Value

string

FormViewAllowed

This property gets/sets if form view is allowed (unbound forms are always in form view regardless the value of this property)

public bool FormViewAllowed { get; set; }

Property Value

bool

FormViewShown

Returns True if the form is not showing a list of records.

public bool FormViewShown { get; }

Property Value

bool

GroupIdentifier

This property gets the current GroupIdentifier. (A SQL expression)

public string GroupIdentifier { get; }

Property Value

string

GroupIdentifierScript

This property gets the current GroupIdentifierScript. This is a script expression that can be used to create the display value of the group identifier.

public string GroupIdentifierScript { get; }

Property Value

string

HelpAvailable

Returns True if help is available for this form.

public bool HelpAvailable { get; }

Property Value

bool

Interactive

This property gets/sets if this form (in form view) is to be shown 'Interactive'. This means that the system tries to perform updates 'under water' without posting the whole form each time. Also for example switching tabs in the form will be more fluent.

public bool Interactive { get; set; }

Property Value

bool

IsSystemForm

Returns True if the current form is a system form.

public bool IsSystemForm { get; }

Property Value

bool

this[object]

This default property allowes a Control to be returned as default property.

public Control this[object pIndex] { get; }

Parameters

pIndex object

The index (index number or name) of the control.

Property Value

Control

A control (or nothing if not found)

LayoutMode

This property gets/sets the LayoutMode for the form. This controls how the captions are shown (left, right, above). Use one of these values: 'CAPTIONSLEFT', 'CAPTIONSRIGHT', 'CAPTIONSABOVE'. Please note that when using Bootstrap design, there will be no visible difference between CAPTIONSLEFT and CAPTIONSRIGHT. This is then to be done using CSS.

public string LayoutMode { get; set; }

Property Value

string

ListView

This property gets/sets if listview is shown. You can only switch to another mode if that mode is allowed.

public bool ListView { get; set; }

Property Value

bool

ListViewAllowed

This property gets/sets if list view is allowed (only applies to bound forms)

public bool ListViewAllowed { get; set; }

Property Value

bool

ListViewAsContinuousForms

This property allows the list view to show as continous forms

public bool ListViewAsContinuousForms { get; set; }

Property Value

bool

ListViewRecordCount

This property gets/sets the number of records that is to be shown on one page in listview. A hard limit of 1000 is applied.

public long ListViewRecordCount { get; set; }

Property Value

long

ListViewShown

Returns True if the form is actually shown in ListView. When for example inserting a new record, Returns False, even if ListView == True

public bool ListViewShown { get; }

Property Value

bool

ListViewStartRecordNumber

This property gets/sets the one based record number (not ID) of the first record to show in listview.

public long ListViewStartRecordNumber { get; }

Property Value

long

MDIform

Returns True for MDI forms. MDI forms (Multiple Document Interface) are forms that are shown next to each other (as in the Polar Studio editor) or are opened as a sub-form in a normal form.

public bool MDIform { get; }

Property Value

bool

MessagesProfile

Returns the messages profile for the current session.

public string MessagesProfile { get; }

Property Value

string

Modal

This property gets/sets if this form is a modal form. Modal forms are 'on top' and will disable the menu and the windows tabs.

public bool Modal { get; set; }

Property Value

bool

Name

Returns the name of this form as it is set in Polar Studio.

public string Name { get; }

Property Value

string

OrderSettingsName

This property gets/sets the name of the current OrderSettings. This name must match a name as defined in Polar Studio. Also, only one of the AvailableOrderSettings can be chosen. If order settings are available, then it is not possible to un-apply these order settings.

public string OrderSettingsName { get; set; }

Property Value

string

ParentFormID

Returns the ID (FormIDextended) of the ParentForm that opened this form. Please note that this parent form may have been closed in the meanwhile. If no ParentForm is (was) known, then the return-value will be zero. This property will only be filled if one form is actually a parent of the other (not when following a foreign key relation).

public int ParentFormID { get; }

Property Value

int

PreGroupingOrder

This property gets the current PreGroupingOrder. (A SQL OrderBy clause that is put before the GroupIdentifier is determined).

public string PreGroupingOrder { get; }

Property Value

string

RecordID

This property gets/sets the current active RecordID. It returns a long or a NULL. If set, give the RecordID to activate. No error will be raised if the given RecordID is not found.

public object RecordID { get; set; }

Property Value

object

RecordSelectorRecordID

This property gets sets the RecordID for whick the Record Selector must be shown.

public object RecordSelectorRecordID { get; set; }

Property Value

object

SaveAndUndoAllowed

Used to show the save and undo buttons in the user interface. It is automatically set during the render of the form but can be changed in script from False to True if needed.

public bool SaveAndUndoAllowed { get; set; }

Property Value

bool

Session

Returns the (web)session this for is tied to.

public Session Session { get; }

Property Value

Session

Settings

The Settings property gives access to the repository-object representing the current form.

public repForm Settings { get; }

Property Value

repForm

SettingsForGroup

The SettingsForGroup property gives access to the repository-object representing the group-specific setting for the current form for the current user.

public repFormSettings SettingsForGroup { get; }

Property Value

repFormSettings

ShowFormAfterInsert

This property allows the form to automatically switch to form view after the user has inserted a new record.

public bool ShowFormAfterInsert { get; set; }

Property Value

bool

SimplePrint

Returns True if the FormMode is 'SIMPLEPRING'. It can also be used to print the current form by setting this property to True.

public bool SimplePrint { get; set; }

Property Value

bool

SimplePrintAllowed

This property enables/disabled the built in print feature for this form.

public bool SimplePrintAllowed { get; set; }

Property Value

bool

SupportFilter

This property enables/disabled the built in filter form.

public bool SupportFilter { get; set; }

Property Value

bool

SupportHelp

This property enables/disabled the built in help form.

public bool SupportHelp { get; set; }

Property Value

bool

TabSheetCaptionHtmlTC

This property gets/sets the caption for this form as is to be used on the windows tabs.

public string TabSheetCaptionHtmlTC { get; set; }

Property Value

string

TabSheetToolTipTextTC

This property gets/sets the tool tip as is rendered for windows tabs (mouse-over text)

public string TabSheetToolTipTextTC { get; set; }

Property Value

string

TableID

Returns the SysTableID of the table as it is defined in the Polar Studio repository or 0 for unbound forms.

public int TableID { get; }

Property Value

int

TableOrder

This property gets the current TableOrder. This is a SQL OrderBy clause to set the order of the table

public string TableOrder { get; }

Property Value

string

Tag

The Tag is available for scripted use and can be filled with any text.

public string Tag { get; set; }

Property Value

string

TextButtons

Returns the TextButtons for this form. The TextButtons object can be used to create or change custom text buttons.

public TextButtons TextButtons { get; }

Property Value

TextButtons

UIbuttons

Returns all form-buttons that are created in Polar Studio. The buttons are indexed on their name.

public Buttons UIbuttons { get; }

Property Value

Buttons

Variables

The Variables can be used to store custom information in the session

public Dictionary Variables { get; }

Property Value

Dictionary

ZoomedControlName

Returns the name of the memo control that is zoomed in to.

public string ZoomedControlName { get; }

Property Value

string

Methods

Activate()

This method activates this form and brings it to the foreground.

public bool Activate()

Returns

bool

AddNew(bool)

This method is used to add a new record in the form. Is does the same as when the user presses the AddNew button. When the user is not allowed to add a record, this method will not work. If you want to insert a new record even when not allowed, then first perform an AddNew on the dataset, followed by calling this method.

public void AddNew(bool pCloseFormAfterInsert = false)

Parameters

pCloseFormAfterInsert bool

This property can be set to true, to let the form be automatically closed after the new record is saved to the database or the user cancelled the insert.

Caption(bool)

Returns the caption for the form.

public string Caption(bool pBaseCaptionOnly = false)

Parameters

pBaseCaptionOnly bool

This parameter can be passed as True to only get the base caption without a suffix for the current form mode (like ' - Edit')

Returns

string

ClearBlob(string)

This method clear the contents of a blob field if allowed.

public void ClearBlob(string pFullControlName)

Parameters

pFullControlName string

The full HTML field name to clear the blob details for.

ClearEditBuffer()

This method clears the edit buffer as is used to keep edits in a list view.

public void ClearEditBuffer()

Close(bool)

This method closes the form.

public bool Close(bool pAllowCancelClose = false)

Parameters

pAllowCancelClose bool

If the user is allowed to cancel the close action, this parameter can be set to true.

Returns

bool

CreateHTMLfieldName(string, object)

This method can be used to create the name of a HTML field as is to be used when creating custom controls.

public string CreateHTMLfieldName(string pControlName, object pRecordID = null)

Parameters

pControlName string

The bare name of the control (does not have to be an existing name).

pRecordID object

The RecordID this HTML field name is linked to. Will be the current record ID if omitted.

Returns

string

GetContext()

This property gets the Context for this form to use when calling ScriptEvaluate methods.

public Context GetContext()

Returns

Context

The Context object for this form.

GetLock(long)

This method tries to lock the given RecordID. An error message will be returned if getting this lock fails.

public string GetLock(long pRecordID)

Parameters

pRecordID long

The RecordID to lock

Returns

string

An empty string if successful or an error message otherwise.

MemoZoom(string)

This method shows/edits the contents of a memo field 'full screen'.

public void MemoZoom(string pFullControlName)

Parameters

pFullControlName string

The full HTML field name for the field to show/edit.

OpenFilterForm()

This method shows the old Filter screen for this form

public bool OpenFilterForm()

Returns

bool

A boolean indicating the filter form was shown.

OpenHelpForm()

This method shows the help-screen for this form.

public bool OpenHelpForm()

Returns

bool

A boolean indicating the help screen was shown.

OpenQuickList()

This method opens the 'Quick List' screen for this form. The quick list is a list of records the user can use to quickly activate another record without using the list view.

public bool OpenQuickList()

Returns

bool

A boolean indicating the quick list was shown.

ParentForm()

This returns the reference to ParentForm-object (if still available). Please note that in a single-form environment, this could give a reference to a re-opened form of the same type. Also, when the ParentForm has been closed, this method returns Nothing. It is best to access the ParentForm during the OnOpenForm event and copy all properties you need access to later to local variables

public Form ParentForm()

Returns

Form

The Form that opened this form (if available and applicable).

QuickInsertParent(string, long?, bool)

This method inserts a parent record for the given foreign key field if allowed.

public void QuickInsertParent(string pFieldName, long? pRecordID, bool pSuppressValidityCheck = false)

Parameters

pFieldName string

The foreign key field to insert a parent for.

pRecordID long?

The record ID of the record in the current dataset to insert the parent for.

pSuppressValidityCheck bool

This property can be set to True to insert a record in the foreign table, even if inserting in that foreign table is not allowed.

QuickInsertParent(string, object, bool)

This method inserts a parent record for the given foreign key field if allowed.

public void QuickInsertParent(string pFieldName, object pRecordID, bool pSuppressValidityCheck = false)

Parameters

pFieldName string

The foreign key field to insert a parent for.

pRecordID object

The record ID of the record in the current dataset to insert the parent for.

pSuppressValidityCheck bool

This property can be set to True to insert a record in the foreign table, even if inserting in that foreign table is not allowed.

ReRender()

This method will cause the whole form to be re-rendered in case of an interactive form.

public void ReRender()

RegisterOnCancelFormScript(string)

This method registers a script that is to be executed when the users presses the cancel button or cancels an update. This setting will be kept and must be set once (for example in the OnOpenForm event)

public void RegisterOnCancelFormScript(string pScriptExpression)

Parameters

pScriptExpression string

RegisterOnCloseFormScript(string)

This method registers a script that is to be executed when the users closes the form. This setting will be kept and must be set once (for example in the OnOpenForm event)

public void RegisterOnCloseFormScript(string pScriptExpression)

Parameters

pScriptExpression string

RegisterOnUpdateFormRecordScript(string)

This method registers a script that will be executed once (!) when the data of the record is received back from the browser. Can be used in custom controls to do specific updates or conversions. Must be registered every time the control is rendered.

public void RegisterOnUpdateFormRecordScript(string pScriptExpression)

Parameters

pScriptExpression string

A script expression that is to be executed.

RemoveFilter()

This method removes the filters from the dataset.

public void RemoveFilter()

Render(clsString, Request)

This method renders the form to the given pResultString. Is normally used internally within Polar Studio, but can be used for MDI forms.

public void Render(clsString pResultString, Request pRequest)

Parameters

pResultString clsString

The clsString object the html for this form must be appended to.

pRequest Request

The request that is currently processed.

SelectItem(string)

This method opens the old 'Select Item' screen. This screen was used to select a new value for a foreign key.

public void SelectItem(string pHTMLfieldName)

Parameters

pHTMLfieldName string

The full HTML field name for the field to select a new value for.

SendToBack()

This method sends the form to the back, thus showing the next visible form. If only one form is open, this method has no effect.

public void SendToBack()

SetButtons()

This method determines the states (visible/enabled) of all UI buttons for this form. Is normally called from within Polar Studio.

public void SetButtons()

SetOrderSettings(string, string, string, string)

This method changes the order settings for the current form.

public bool SetOrderSettings(string pTableOrder, string pGroupIdentifier, string pGroupIdentifierScript, string pPreGroupingOrder)

Parameters

pTableOrder string

A SQL OrderBy clause to set the order of the table

pGroupIdentifier string

A SQL expression for the Group Identifier

pGroupIdentifierScript string

A script expression that can be used to create the display value of the group identifier.

pPreGroupingOrder string

A SQL OrderBy clause that is put before the GroupIdentifier is determined

Returns

bool

ShowBlobDetails(string)

This method shows the details of a blob field if allowed.

public void ShowBlobDetails(string pFullControlName)

Parameters

pFullControlName string

The full HTML field name to show the blob details for.

SwitchToFormView(long?)

This method switches the form to form view and to activate the given record if allowed.

public void SwitchToFormView(long? pRecordID)

Parameters

pRecordID long?

The record ID to activate.

SwitchToFormView(object)

This method switches the form to form view and to activate the given record if allowed.

public void SwitchToFormView(object pRecordID = null)

Parameters

pRecordID object

The record ID to activate.

SwitchToListView()

This method switches the form to list view if allowed.

public void SwitchToListView()