Top
Top
LibraryEASYProcess Reference ManualWebPartsFieldsHyperLink
KHyperLink Use Examples
Field:HyperLink

Appearance

AllowSorting

This property is only used when the field is in a list section. If AllowSorting is set to ‘True’, then the list will display a sort option at the top of the field column in the lest. This sort option can be selected and the list will be sorted on that column. To make a field the default sorting option for a section set the sections property SortField to the field.

Description

When the field has a Description, the text here displays in that description. Blank and spaces are accepted values for this property.

Whether a not a field has a description is determined by the section the field is in. Each section has a property called “Field Description” which has options to either not display a description (Field Description: No) or where it should be displayed in relation to the field (Field Description: left, right, top).

OverrideRender
ToolTip

If this property is not blank, the text entered here is displayed in a message when the user hovers over the field.

Enabled, RenderIfNotVisible, Visible
Border
DisplayAsLabel

When this property is set to “Yes” hyperlink is displayed as label and it becomes not clickable. The default value is “No”.

ImageUrl
MaxTextLength

This is how many characters can be displayed. This is only for fields which accept text input. The text will be cut off at the limit.

Text

This property is where you can set the text to be displayed in the field when the page loads.


Basic Properties

Active

Active is defaulted to true. When true the field gets added to the page and can be used. If false the field is not added to the page and its value can not be used. It is as good as deleted. Use this if you are not sure to delete the field.

IdMode

IdMode determines the id that the field gets when it is put on the page.There are two options: Default and NameOnly. Default set the id to [FieldName]@[WebPartId]@[index]@[index]. NameOnly sets the id to [FieldName].


Download

DownloadMode

If the field is within a list section, the user has the ability to download the list section to a CSV file. This property controls which columns will be included in that file. Options are “Display Only”, “Download Only”,  and “Display and Download”. Display refers to the column appearing on the page and download refers to the column appearing in the file downloaded.


Event

OnClick

You can write Javascript in this property that will run when an onclick event occurs for the field.


Globalization

Translate

Translate can be set to ‘True’ or ‘False’ if set to ‘True’ when the language is switched from the default language the field contents will be translated. If set to ‘False’ it will not be translated.


Layout

DescriptionHorizontalAlign, DescriptionVerticalAlign, FieldDescriptionHeight, FieldDescriptionWidth, Height, HorizontalAlign, tabindex, VerticalAlign, Width

The horizontal alignment of the field description is controlled by DescriptionHorizaontalAlign and can be set to left, center, or right

The vertical alignment of the field description is controlled by DescriptionVerticalAlign and can be set to top, middle, bottom, or baseline

The horizontal alignment of the field is controlled by HorizontalAlign and can be set to left, center, or right

The vertical alignment of the field is controlled by VerticalAlign and can be set to top, middle, bottom, or baseline

The height of the field description is controlled by FieldDescriptionHeight

The width of the field description is controlled by FieldDescriptionWidth

The height of the field is controlled by Height

Control the tab order by setting the Tabindex of each field.

The width of the field is controlled by Width


Navigation

EncryptQueryString

Yes or No values. Defaults to Yes. If Yes the parameters that are passed will be encrypted.

FriendlyUrl

This is the url that the user sees. The page is actually going to the NavigateUrl with the Parameters. A FriendlyUrl can only map to a single NavigateUrl and Parameters and must not be a page that already exists. When adding a value to this property records are automatically created in the tables EP_CMS_FriendlyUrls which holds the mapping from FriendlyUrl to PageName and EP_CMS_FriendlyUrl_Parameters which holds any parameters that need to be passed in for that FriendlyUrl. Records in these tables can be manually created in order to create FriendlyUrls if desired.  

Name
NavigateUrl

The url that the link will forward to.

ParamSendMethod
Target

The target attribute of the link. Can be _blank, _self, _parent, _top, framename.


Parameters

Parameter1Name, Parameter1Value, Parameter2Name, Parameter2Value, Parameter3Name, Parameter3Value, Parameter4Name, Parameter4Value, Parameter5Name, Parameter5Value, Parameter6Name, Parameter6Value, Parameter7Name, Parameter7Value, Parameter8Name, Parameter8Value, Parameter9Name, Parameter9Value

Parameters that will be passed into the link. ParameterName is the name of the parameter that will be passed as a query string. ParameterValue is the value of the parameter that is passed. These parameters are passed as Query Strings.


Parameters - More

Parameter10Name, Parameter10Value, Parameter11Name, Parameter11Value, Parameter12Name, Parameter12Value, Parameter13Name, Parameter13Value, Parameter14Name, Parameter14Value, Parameter15Name, Parameter15Value, Parameter16Name, Parameter16Value, Parameter17Name, Parameter17Value, Parameter18Name, Parameter18Value, Parameter19Name, Parameter19Value, Parameter20Name, Parameter20Value, Parameter21Name, Parameter21Value, Parameter22Name, Parameter22Value, Parameter23Name, Parameter23Value, Parameter24Name, Parameter24Value, Parameter25Name, Parameter25Value, Parameter26Name, Parameter26Value, Parameter27Name, Parameter27Value, Parameter28Name, Parameter28Value, Parameter29Name, Parameter29Value, Parameter30Name, Parameter30Value

Parameters that will be passed into the link. ParameterName is the name of the parameter that will be passed as a query string. ParameterValue is the value of the parameter that is passed. These parameters are passed as Query Strings.


Responsive Design

RWDVisibility

These two properties are used for adaptive design for phone display.

RWDAutoFormat : By default EASYProcess will does auto format for a control for adaptive design. For example, section NoOfColumns will always be set to 1 for phone display. By making RWDAutoFormat to false, you can stop such format from happening automatically. This property is only available at WebPart and Section level.
RWDVisibility : Its value can be All, Desktop, Phone. ‘All’ means this control will display in both desktop browser and phone. Desktop will force this control to display in desktop browser, Phone will force this control to display in phone browser. If value is blank, then it will default to ‘All’.


Style

CellStyle, CssClass, FieldDescriptionStyle, SkinId, Style
  • SkinId : A skin is a predefined collection of classes for a particular control. Once a SkinId is specified for a control, a set of classes in that control will be automatically set. For example, Class in Label will be ‘Label-<SkinId>-Class’. Every control defaults to SkinId = ‘Default’. You can have multiple skins for a particular control but only one can be applied at a time. Values for these classes are specified using EASYProcess CSS feature. To understand how CSS and Skin Id works review document here.
  • Class : By making SkinId blank, you can use your own class name. Make sure you define class name in your own CSS or using EASYProcess CSS feature.
  • Style : Apply inline styling using this property. Any value specified here will be applied directly. You can use EASYProcess style builder to create style string.
  • DescriptionStyle : Use this property to style description of this control.
  • CellStyle : Use this property to style container cell for a control.
  • To style other elements in this control, which are children of this control, use CSS selectors for children.


Window Mode

OpenWindow

Yes or No. Defaults to No. If yes it will open a new window which will contain a single webpart instead of an entire page.

OpenWindowScriptFunction

“OpenWindowScriptFunction” takes in a function name and override the default function which is responsible for opening window when hyperlinks are clicked.

WebPartId

The WebPartId of the webpart that the window will open.

WindowMode

There are two options. Modal/Inline which opens a windows inside the existing page. NewWindow which opens a new browser window.

WindowParameter

Specify properties that the window that opens will have. For example width, height, scrollbar, etc.

WindowUrl

The url that the window will open.


Powered by EASYProcess (© 2019 K-Rise Systems, Inc).