Page History
Cache | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
bgcolorGets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set. Returns Supported Clients Sample borderGets or sets the border attribute(s) of a specified element.
The border attributes:
borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size - (numeric value) for: bottom, left, right, top.
color - (hexadecimal value) for: bottom, left, right, top.
dash pattern - (numeric value) for selected side(s).
rounding radius - (numeric value) for selected side(s).
It only returns it's correct value if it was explicitly set.
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType". Returns Supported Clients Sample enabledGets or sets the enabled state of a specified field, also known as "grayed".
true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).
NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).
NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.
NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide. Returns Supported Clients Sample fgcolorGets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set. Returns Supported Clients Sample fontGets or sets the font name, style, and size of an element.
font name - the name of the font family.
style - the type of the font. (plain = 0; bold = 1; italic = 2; bold-italic = 3).
size - the size of the font (in points).
It only returns it's correct value if it was explicitly set. Returns Supported Clients Sample readOnlyGets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).
NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied. Returns Supported Clients Sample toolTipTextGets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
NOTE: HTML should be used for multi-line tooltips; you can also use any valid HTML tags to format tooltip text. Returns Supported Clients Sample transparentGets or sets the transparency of an element; true - transparent; false - not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color Returns Supported Clients Sample visibleGets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
NOTE: The visibility of an element is not persistent; the state of visibility only applies to the current user in his/her current session. Returns Supported Clients Sample addStyleClass(styleName)Adds a style to the styleClass property. This works only for NGClient where multiple styles are supported. Parameters Supported Clients Sample deleteRecord()Deletes the currently selected portal row in the foundset of the specified portal. Supported Clients Sample duplicateRecord()Duplicates the currently selected portal row in the foundset of the specified portal. Supported Clients Sample duplicateRecord(addOnTop)Duplicates the currently selected portal row in the foundset of the specified portal. Parameters Supported Clients Sample getAbsoluteFormLocationY()Returns the absolute form (designed) Y location. Returns Supported Clients Sample getClientProperty(key)Gets the specified client property for the element based on a key.
NOTE: Depending on the operating system, a user interface property name may be available. Parameters Returns Supported Clients Sample getDesignProperties()Get the design-time properties of an element. Returns Supported Clients Sample getDesignTimeProperty(key)Get a design-time property of an element. Parameters Returns Supported Clients Sample getElementType()Returns the type of a specified element. Returns Supported Clients Sample getFormName()Returns the name of the form. (may be empty string as well) Returns Supported Clients Sample getHeight()Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1); Returns Supported Clients Sample getLocationX()Returns the x location of the current element.
NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10); Returns Supported Clients Sample getLocationY()Returns the y location of the current element. The method can only be used in Record view.
NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10); Returns Supported Clients Sample getName()Returns the name of an element. (may be null as well) Returns Supported Clients Sample getScrollX()Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10); Returns Supported Clients Sample getScrollY()Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10); Returns Supported Clients Sample getSelectedIndex()Gets the selected record index in the current cached foundset in the specified portal. Returns Supported Clients Sample getSortColumns()Returns the sort columns names of the current portal (as comma separated string). Returns Supported Clients Sample getWidth()Returns the width of the current element.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1); Returns Supported Clients Sample hasStyleClass(styleName)Check if an element already have a style from the styleClass property. Parameters Supported Clients Sample newRecord()Creates a new portal row in the foundset of the specified portal. Supported Clients Sample newRecord(addOnTop)Creates a new portal row in the foundset of the specified portal. Parameters Supported Clients Sample putClientProperty(key, value)Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available. Parameters Supported Clients Sample removeStyleClass(styleName)Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported. Parameters Supported Clients Sample setLocation(x, y)Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10); Parameters Supported Clients Sample setScroll(x, y)Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new location
forms.company.elements.portal50.setScroll(x+10,y+10); Parameters Supported Clients Sample setSelectedIndex(index)Sets the selected record index in the current cached foundset in the specified portal. Parameters Supported Clients Sample setSize(width, height)Sets the size of an element. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1); Parameters Supported Clients Sample |