Skip to content

Class: AINoticeFormCellProxy

AINoticeFormCellProxy is a developer-facing interface that provides access to an AINotice FormCell control and allows customizations. In addition, it provides access to the IFormCellProxy interface.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Currently none in this class.

Inherited Properties

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

Constructor

+ new AINoticeFormCellProxy(context: IContext): AINoticeFormCellProxy

Inherited from FormCellControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: AINoticeFormCellProxy

Methods

getHyperlinkText

getHyperlinkText(): string

Returns the HyperlinkText property value of the AINotice FormCell.

Implementation of IAINoticeFormCellProxy.getHyperlinkText

Returns: string


getMessage

getMessage(): string

Returns the Message property value of the AINotice FormCell.

Implementation of IAINoticeFormCellProxy.getMessage

Returns: string


getStyles

getStyles(): any

Returns the Styles object of the AINotice FormCell.

Implementation of IAINoticeFormCellProxy.getStyles

Returns: any


setHyperlinkText

setHyperlinkText(hyperlinkText: string): Promise<any>

Sets the HyperlinkText property of the AINotice FormCell. Pass an empty string to hide the hyperlink.

Implementation of IAINoticeFormCellProxy.setHyperlinkText

Parameters:

Name Type Description
hyperlinkText string value to set.

Returns: Promise<any>


setMessage

setMessage(message: string): Promise<any>

Sets the Message property of the AINotice FormCell.

Implementation of IAINoticeFormCellProxy.setMessage

Parameters:

Name Type Description
message string value to set.

Returns: Promise<any>


setStyles

setStyles(styles: any): Promise<any>

Sets the Styles object of the AINotice FormCell. Pass null to clear all inline styles. Supported sub-objects: "Background" (background-color, padding-top, padding-bottom, padding-leading, padding-trailing) and "Message" (font-color, font-size).

Implementation of IAINoticeFormCellProxy.setStyles

Parameters:

Name Type Description
styles any value to set, or null to clear.

Returns: Promise<any>