HyperlinkControl
HyperlinkControl is one these types:
HyperlinkControlListHyperlinkControl
HyperlinkControl Functions
| getHref | HyperlinkControl.getHref( ) | The URL of the hyperlink when property #isUseExternalURL() is true. |
| setHref | HyperlinkControl.setHref( href ) | Sets the URL of the hyperlink when property #isUseExternalURL() is true. |
| isSkipValidation | HyperlinkControl.isSkipValidation( ) | Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event. |
| setSkipValidation | HyperlinkControl.setSkipValidation( skipValidation ) | Specifies whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event. |
| getTarget | HyperlinkControl.getTarget( ) | The target window id when the link is configured as #isUseExternalURL(). |
| setTarget | HyperlinkControl.setTarget( target ) | Sets the target window id when the link is configured as #isUseExternalURL(). |
| getText | HyperlinkControl.getText( ) | Returns the com.ebasetech.xi.api.Text object for the hyperlink text. |
| getTitle | HyperlinkControl.getTitle( ) | Returns the com.ebasetech.xi.api.Text object for the mouse over text. |
| isUseExternalURL | HyperlinkControl.isUseExternalURL( ) | Indicates whether the link is external or internal. |
| setUseExternalURL | HyperlinkControl.setUseExternalURL( useExternalURL ) | Sets the link type. |
AriaControlProperties Functions
| addAriaCustomAttribute | HyperlinkControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | HyperlinkControl.getAriaCustomAttributes( ) | Returns a comma separated list of the ARIA custom attributes for the control. |
| setAriaCustomAttributes | HyperlinkControl.setAriaCustomAttributes( ariaCustomAttributes ) | Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value. |
| getAriaDescribedBy | HyperlinkControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | HyperlinkControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | HyperlinkControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the ARIA label text. |
| getAriaRole | HyperlinkControl.getAriaRole( ) | Returns the ARIA role for the control. |
| setAriaRole | HyperlinkControl.setAriaRole( role ) | Sets the ARIA role for the control. |
| removeAriaCustomAttribute | HyperlinkControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
BackgroundStyleProperties Functions
| getBackgroundColor | HyperlinkControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | HyperlinkControl.setBackgroundColor( backgroundColor ) | Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used. |
| getBackgroundImage | HyperlinkControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | HyperlinkControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | HyperlinkControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | HyperlinkControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | HyperlinkControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | HyperlinkControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BootstrapButtonStyle Functions
| getBootstrapSize | HyperlinkControl.getBootstrapSize( ) | The current bootstrap size |
| setBootstrapSize | HyperlinkControl.setBootstrapSize( alignment ) | Sets the bootstrap size. |
| getBootstrapState | HyperlinkControl.getBootstrapState( ) | The current bootstrap state |
| setBootstrapState | HyperlinkControl.setBootstrapState( alignment ) | Sets the bootstrap state. |
| getBootstrapStyle | HyperlinkControl.getBootstrapStyle( ) | The current bootstrap style |
| setBootstrapStyle | HyperlinkControl.setBootstrapStyle( alignment ) | Sets the bootstrap style. |
BorderStyleProperties Functions
| getBorderColor | HyperlinkControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | HyperlinkControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | HyperlinkControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | HyperlinkControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | HyperlinkControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | HyperlinkControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | HyperlinkControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | HyperlinkControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | HyperlinkControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | HyperlinkControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | HyperlinkControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | HyperlinkControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | HyperlinkControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | HyperlinkControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | HyperlinkControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | HyperlinkControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | HyperlinkControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | HyperlinkControl.getAll( ) | Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page. |
| isContainer | HyperlinkControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | HyperlinkControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | HyperlinkControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | HyperlinkControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | HyperlinkControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | HyperlinkControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | HyperlinkControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | HyperlinkControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | HyperlinkControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | HyperlinkControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | HyperlinkControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | HyperlinkControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | HyperlinkControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | HyperlinkControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | HyperlinkControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | HyperlinkControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | HyperlinkControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | HyperlinkControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | HyperlinkControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | HyperlinkControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | HyperlinkControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | HyperlinkControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | HyperlinkControl.isNewLine( ) | Returns the new line property. |
| setNewLine | HyperlinkControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | HyperlinkControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | HyperlinkControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | HyperlinkControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | HyperlinkControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | HyperlinkControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | HyperlinkControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | HyperlinkControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | HyperlinkControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | HyperlinkControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | HyperlinkControl.isShowing( ) | Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false. |
| getStyle | HyperlinkControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | HyperlinkControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | HyperlinkControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | HyperlinkControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | HyperlinkControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | HyperlinkControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
HyperlinkProperties Functions
| getActiveTextStyle | HyperlinkControl.getActiveTextStyle( ) | Hyperlink properties that apply to the active state. |
| getHoverTextStyle | HyperlinkControl.getHoverTextStyle( ) | Hyperlink properties that apply to the hover state. |
| getLinkedTextStyle | HyperlinkControl.getLinkedTextStyle( ) | Hyperlink properties that apply to the linked state. |
| getVisitedTextStyle | HyperlinkControl.getVisitedTextStyle( ) | Hyperlink properties that apply to the visited state. |
MarginStyleProperties Functions
| getAllMargin | HyperlinkControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | HyperlinkControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | HyperlinkControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | HyperlinkControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | HyperlinkControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | HyperlinkControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | HyperlinkControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | HyperlinkControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | HyperlinkControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | HyperlinkControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | HyperlinkControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | HyperlinkControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | HyperlinkControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | HyperlinkControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | HyperlinkControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | HyperlinkControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | HyperlinkControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | HyperlinkControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | HyperlinkControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | HyperlinkControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | HyperlinkControl.getLineHeight( ) | Line height. |
| setLineHeight | HyperlinkControl.setLineHeight( lineHeight ) | Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used. |
| getTextBold | HyperlinkControl.getTextBold( ) | Text bold setting. |
| setTextBold | HyperlinkControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | HyperlinkControl.getTextColor( ) | Text color. |
| setTextColor | HyperlinkControl.setTextColor( textColor ) | Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used. |
| getTextDecoration | HyperlinkControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | HyperlinkControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | HyperlinkControl.getTextFont( ) | List of text fonts. |
| setTextFont | HyperlinkControl.setTextFont( textFont ) | Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used. |
| getTextItalic | HyperlinkControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | HyperlinkControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | HyperlinkControl.getTextSize( ) | Text size. |
| setTextSize | HyperlinkControl.setTextSize( textSize ) | Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used. |
MessageContainer Functions
| addErrorMessage | HyperlinkControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | HyperlinkControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | HyperlinkControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | HyperlinkControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | HyperlinkControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | HyperlinkControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | HyperlinkControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | HyperlinkControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | HyperlinkControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | HyperlinkControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | HyperlinkControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | HyperlinkControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | HyperlinkControl.getElementName( ) | Returns the element name |
| getElementType | HyperlinkControl.getElementType( ) | Returns the element type |
A hyperlink can be either external meaning that the link is to a URL outside of the current form, or internal meaning that the link should trigger an internal event. This is configured by property #isUseExternalURL().
When the link is configured as external, the hyperlink can be configured with properties #getHref() and #getTarget(); when the link is internal, the event scripts are configured in the designer via the On Click event.
Further documentation.