Blog Single Author Fullwidth

The Hyperlink control targets Sharepoint columns that store hyperlinks or picture urls.

Type : Hyperlink

Name

Provides a unique name for the control.

Binding

Indicates if the control is

• Unbound
• Bound to list column
• Is a label for a control bound to list column

Enabled for new records

Sets if the control will be enabled or disabled when the forms handles a new record

Enabled for existing records

Sets if the control will be enabled or disabled when the forms handles an existing record

Required

Marks the cotnrol as Required.

By default, the system recognizes required fields and marks them with this flag. Additionaly, controls can be marked as required event if the bound column is not.

Enabled Formula

Set an expression then will be evaluated during run-time and enable or disable the control.

The expression must be in javascript and should return a boolean value.

Dependencies between controls are automatically identified and the expression is re-calculated every time a control affecting the formula changes.

Example :

Visibility Formula

Define a valid formula (using javascript) that will be evaluated during runtime to show or hide the control.

The expression should return a boolean value.

For example :

Value

This property defines how the control will get its value.

 

Here are the available options :

1. The value is Static (this is the default for label controls)
2. The value will be provided by the user (Not applicable for labels)
3. The value will be calculated by a formula
4. The value will be retrieved from a list query
5. The value will be provided by a web service call
6. The value will be provided by a SQL query

Static value

A static text must be set in the appropriate designer control.

Formula

A javascript expression must be set that will provide the value for the control.

If the formula contains references to other controls, dependencies will be automatically identifies during run-time and the value will be updated to reflect changes.

Example :

There is an additional option that instructs the form to perform calculations only for new records. Existing records will keep their original value.

List Query

A predefined list query is bound to the value of the control. So during form initialization, the specified list query is executed and if it returns any item, it selects the first one and it will apply the value to the label based on the following rule :

If a Field Name has been selected in the corresponding box, that specific column will be used from the list item to fill the control value.

If the Field Name is left blank, the first column retrieved will be used.

Web Service

The same as above, the required web service is selected and after the web service retrieves data, the first item will be used to update the control value. If no Field Name is set, the control will receive the first field of the  retrieved item.

SQL Query

Works the same way ListQueries and Web Service works.

Default Value

The default value has any effect only of the control is bound to a list column.

For unbound controls, the default value is ignored.

You may set a static value here or use a formula by starting your input with the “equals” (=) sign.

Example :

Width

Not Applicable for the Hyperlink control.

Height

Not Applicable for the Hyperlink control.

H.Alignment

Defines the horizontal alignment of the parent cell (values : left, right, center)

V.Alignment

Defines the vertical alignment of the parent cell (values : top, bottom, center)

Fore Color

Defines the fore color of the control

Back Color

Not Applicable for the Hyperlink control

Cell Color

Defines the color of the parent cell.

Font Size

Declares the font size of the text

Margin

Sets the margin applied to the control, that is, the spacing between the control and the cell borders.

Font Bold

Changes the weight of the font used

Italics

Changes the font style for the control text

Not Applicable for this control

Text

The hyperlink text. If left blank, the URL will be shown.

Target

The hyperlink target (i.e. _blank)

Actions

The actions to be executed once the button is clicked are defined here. The sequence of the execution follows the order of the actions definition. In order to add an Action entry in this collection, press the button. Each action has the following properties:

Type: Sets the type of the action to be executed. Available values:

• Script: Javascript code to be executed. See “Form Properties and Methods” and “Controls Properties and Methods” article for a list of available functions and code samples.
• SetValue: Provides a value (specified to the “Value” property) to the control specified in the “ControlName” property.

Value: The script to be executed (in case of script actions) or the value to be set on the control (in case of SetValue actions). For SetValue actions, references to controls are allowed, for example {c_Title}.

The following example will display a message to the form once the button is clicked, and then set the title’s text to the c_Description control:

 

Sets the script that will be executed at the value-change event of the control.

Example :

 

Either inside formulas or when writing javascript to accomplish complex requirements, you can use the client-side API provided by PowerForms – HTML.

A global variable named “form” is available wherver you can use script :

• In form events (Load, Validation, etc)
• Inside Enabled and Visibility formulas
• In control Value-Change events
• In custom events provided by specific controls (like grids)

 

DataItem

Type : Object

Represents the record data. Each property of the object represents a list column.

The internal names of columns have been used to build this object.

MaintainTabSelection

Type : Bool

In case that the form contains more than one tab selections, after the save action, the last selected tab will maintain selected if it is set true.

Loaded

Type : Bool

This property is true while the form is loading and becomes false as soon as the user starts editing the data in the form.

The is useful when you want to change the value of controls during the Value-Change event of another control.

Since the Value-Change events are raised even when the form is initialized, that may have unwanted results.

For example :

You want every time the user selects a specific customer from a combobox, to automatically set the priority combo to “High”. This should act as a default value for that control, but the user may change it afterwards. So we apply this rule only when the value of the combo is changed by a user action.

Example:

FieldValue(controlName)

Return type : string

Used to retrieve the current value of a control on the form.

The value is always retrieved as a string.

For date values, ANSI format is used.

For numeric values, US locale is used.

For lookup values, the ID;#TITLE format is used.

For boolean values, 1 or 0 is returned.

Example :

Enabled formula example :

FieldValue_Name(controlName)

Return type : string

This method is used for lookup controls only and it returns the TITLE part of the control value (ID;#TITLE)

For example, a combobox lookup control has the value : 2;#Open

FieldValue_Value(controlName)

Return type : string

This method is used for lookup controls only and it returns the ID part of the control value (ID;#TITLE)

For example, a combobox lookup control has the value : 2;#Open

FieldValues(controlName, separator)

Return type : string

This method is used for multi-lookup controls only.

The FieldValue(controlName) method for multi-lookup controls returns the value in the ID1;TITLE1;#ID2;#TITLE2;#… format.

This method returns all the ID parts inside the value, concatenated by the separator provided as a parameter.

For example:

FieldNames(controlName, separator)

Return type : string

This method is used for multi-lookup controls only.

The FieldValue(controlName) method for multi-lookup controls returns the value in the ID1;TITLE1;#ID2;#TITLE2;#… format.

This method returns all the TITLE parts inside the value, concatenated by the separator provided as a parameter.

For example:

UserID()

Return type : string

This method returns the ID of the current SharePoint user.

Example :

UserFullName()

Retutn type : string

Returns the name of the current user

Example :

LoginName()

Retutn type : string

Returns the login name of the current user

Example :

UserInGroup(idOrName)

Return type : bool

Retutns true if the current user belongs to a group having the provided id or name.

Example :

CurrentUser()

Return type : object

Returns a structure containing information about the current user.

User Properties :

ID, FullName, LoginName, Email, Groups (array of groups)

Group Properties

ID, Name

Example :

IsNewRecord()

Return type : bool

Returns true if we are currently in a new record, otherwise it retuns false.

Example :

ViewMode()

Return type : bool

Returns true if the form is in view mode. This is important to know specially when dealing with script that enables controls.

Example :

A script like the following written inside the LoadCompleted script of the form, would have the result that the specific control would be enabled even when the form is in ViewMode.

ShowMessage(message)

Return type : None

Displays a short message in a placeholder between the toolbar and the form.

It may be used to provide alerts and instructions to the end user.

Example :

MessageForm(message, title, callback)

Return type : None

Shows a modal popup message form to the user.

The message and title parameters are used to set the body and title of the dialog.

If a callback method is specified, the callback is executed when the users closes the form.

Example :

CloseMessageForm()

Return type : None

Closes the above message form programmatically.

Example :

 

ShowButton(buttonName)

Return type : None

Shows a toolbar button.

In order for this method to work, the user must first have the appropriate rights to press that button and the designer of the form must have allowed this button to be available on the form.

Example :

Available button names (Case Insensitive) : “New”, “Save”, “SaveAndExit”, “Delete”, “Cancel”, “Edit”, “Help”, “Design”, “Print”

HideButton(buttonName)

Return type : None

Hides a button from the toolbar.

Available button names (Case Insensitive) : “New”, “Save”, “SaveAndExit”, “Delete”, “Cancel”, “Edit”, “Help”, “Design”, “Print”

Example :

RequestValue(key)

Return type : string

Searches inside the window querystring to find a key matching the specified parameter.

It returns the value of the querystring parameter.

For example (assuming a page with the url : “http://servername/Lists/EditPage.aspx?IsDlg=1”)

SendEmail(to, subject, body, callback)

Return type : None

Uses the SharePoint infrastructure to send an email. The callback (optional) will be executed as soon as the operation completes.

Example :

The variable that will be passed to the callback will have the following properties :

Success : Type = bool

ErrorMessage : Type = string

CallWebService(wsName, callback)

Return type : None

Used to manually execute a predefined web service.

Example :

In the following example we call a predefined web service targeting the _vti_bin/Lists.asmx default service of SharePoint. Inside the callback, it checks for any errors and then loops all the results to create a single <a> hyperlink for each list retrieved.

ExecuteSQLQuery(queryName, callback)

Return type : None

Used to manually execute a predefined SQL query.

Example :

 

LoadListQuery(listQueryName,callback)

Return type: None

Used to manually execute a predefined list query.

Example:

 

LoadRecords(listUrl, listIdOrName, viewIdOrName, criteria, fieldsToRetrieve, sortField, sortAscending, rowLimit, callback)

Return type : None

Used to manually load an array of list items based on specified criteria. The criteria is an array of pf.SearchSpec objects. The “fieldsToRetrieve” parameter is a string array of field names; if null then all fields are returned. If row is greater than zero then all rows are returned.

Example:

 

LoadRecord(listUrl, listIdOrName, itemId, callback)

Return type : None

Used to manually load a list item through script based on its ID.

 

 

DeleteRecords(listUrl, listIdOrName, viewIdOrName, specs, sortField, sortAscending, rowLimit, callback)

 

Return type : None

Used to delete an array of list items based on specified criteria.

The url of the list, the list title or the view id of the records must be passed as parameters. The criteria (specs) is an array of pf.SearchSpec objects.

 

Example:

 

 

DeleteRecord(listUrl, listIdOrName, itemId, callback)

Return type : None

Used to delete a record inside a list.

The url of the list, the list title and the id of the record must be passed as parameters.

Example :

DeleteCurrentRecord(confirm)

ReturnType : None

Used to delete the current record. It takes a parameter to force or ommit the confirmation message presented to the end user.

Example :

CancelRecord()

Return type : None

It has the same effect with that when the user presses the Cancel button in the toolbar.

Example :

SaveRecord() or SaveCurrentRecord()

Return type : None

Saves the current record. The method has the same effect with that when the users press the “Save” button.

Validations are applied to the form data (either required fields or custom validation code from script)

Example :

SaveRecord(url, listIdOrName, listItem, callback)

Saves the provided list item. The item should be a javascript object having properties named after the column names we want to update.

Example :

SaveAndExit()

Return type : None

Performs the same action which is performed by the Save-and-Close button of the toolbar.

Example :

GetSectionByKey(key)

Return type : FormSection object

Returs a section object that matches the key provided.

Each section in a form may have an identifier key (you can set this up using the appropriate section-properties form inside the run-time designer)

Example

ExpandSection(sectionKey)

Return type : None

Expands a form section.

Example :

CollapseSection(sectionKey)

Return type : None

Collapses a form section

Example :

HideSection(sectionKey)

Return type : None

Hides a form section

Example :

ShowSection(sectionKey)

Return type : None

Shows a form section that is hidden

Example :

GetControl(controlName)

Return type : FormControl object

Searches the form for a control with the name passed as a parameter.

Returns the control object found or null if no control matches the specified name.

The control object returned has its own methods described here :

Control Properties and Methods

Example:

 

GetControlByTargetFieldName(columnName)

ReturnType : FormControl object

Searches inside the form controls to find one that is bound to the specified list column name.

Example :

HideTab(index)

ReturnType : None

Hides a tab item by its index (the index is zero based).

Example :

ShowTab(index)

ReturnType : None

Shows a tab item by its index (the index is zero based).

Example :

SetSectionBorderThickness(key, thickness)

Return Type : None

Changes the thickness of a section border.

Parameters :

key : The section key

thickness : The border thickness

Example :

SetSectionBorderColor(key, color)

Return Type : None

Changes the color of a section border.

Example :

SetSectionBackColor(key, color)

Return Type : None

Changes the background color of a section.

Example :

SetSectionCellSpacing(key, spacing)

Return Type : None

Changes the cell spacing of the table inside a section.

Example :

SetSectionCellPadding(key, padding)

Return Type : None

Changes the cell padding of the table inside a section.

Example :

 

SetSectionHeader(key,content)

Return Type : None

Changes the contents of a section’s header.

Example :

 

Attachments() and AttachmentsLoaded event

The Attachments method returns an array of the loaded attachment objects.

Each attachment includes the Filename and FullPath  properties.

Example script written inside the LoadCompleted event of the form that produces thumbnails for all the image attachments of the current list item:

 

 

SetTabHeader(Tab Ident Number, an HTML span containing the text which also sets the visual properties)

Return Type : None

Changes a tab’s header properties.

Example :

 

 

Url()

 

Return Type : String

Returns the form’s list Url. Can be used in script and formulas.

Example :

 

 LoadCurrentUser(Web site Url, callback function)

 

Return Type : Object

Returns the current user’s information in a User object.

User Object:

– LoginName (string)

– ID (string)

– FullName (string)

– IsSiteAdmin (boolean)

– Email (string)

– Groups (object)

Example :

 

CopyFile(sourceUrl, sourceList, docID, targetUrl, targetList, targetFolder, targetFileName, attributes, overwrite, callback)

 

Return Type : None

Copies a document from one document library to another.

Example :

 

 SetAttachmentGridHeight(height)

Return Type : None

Adjusts the height of the grid containing item attachments.

Example :

 

GetTab(Tab Number)

Return Type: Object

Returns the selected tab’s object. The parameter Number is zero-based, meaning that if you want to select the first tab appearing on form, you have to do the following:

 

SetDisplayMode(mode)

Return Type: None

Accepts two parameters: Flat and Normal

Flat mode turns the form into a single page, with every control listed beneath each other, meant to be used for easier page printing.

 

ToggleDisplayMode()

Return Type: None

Switches between Flat and Normal page mode.

 

Log(string message)

Return Type: None

This command is meant to be used with the debugging form (_log=1), allowing you to print a message in the debugging box.

 

OpenUrl(url, caption, width, height, x, y, callback)

Return Type: None

You can use this command to open a new pop-up window, which will navigate to the appointed URL path. You can also include a callback function, which will fire, once the form finishes loading.

 

SelectedTabIndex()

Return Type: Integer

You can use this command to find out the index number of the currently selected Tab. The selected tab index is zero-based, meaning the first tab will return 0, the second tab will return 1 etc.

 

 

HideInnerTab(key, index)

Return Type: None

You can use this command to hide a specific Inner Tab. The inner tab index is zero-based, meaning the first tab will be 0 and the key is the name of it.

 

 

ShowInnerTab(key, index)

Return Type: None

You can use this command to show a specific Inner Tab. The inner tab index is zero-based, meaning the first tab will be 0 and the key is the name of it.

 

 

SelectInnerTab(key, index)

Return Type: None

You can use this command to select a specific Inner Tab. The inner tab index is zero-based, meaning the first tab will be 0 and the key is the name of it.

 

 

SelectedInnerTabIndex(key)

Return Type: Integer

You can use this command to find out the index number of the currently selected Inner Tab. The selected inner tab index is zero-based, meaning the first tab will return 0, the second tab will return 1 etc.

 

 

DisableInnerTab(key, index)