Class sap.m.FormattedTextModule: sap/m/FormattedText

extends Control

The FormattedText control allows the usage of a limited set of tags for inline display of formatted text in HTML format.
Since: 1.38.0.
Constructor Summary
new sap.m.FormattedText(sId?, mSettings?)Constructor for a new FormattedText.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.FormattedText.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.FormattedText with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.FormattedText.getMetadata()Returns a metadata object for class sap.m.FormattedText.
getConvertLinksToAnchorTags()Gets current value of property convertLinksToAnchorTags.
getHeight()Gets current value of property height.
getHtmlText()Gets current value of property htmlText.
getWidth()Gets current value of property width.
setConvertedLinksDefaultTarget(sConvertedLinksDefaultTarget)Sets a new value for property convertedLinksDefaultTarget.
setConvertLinksToAnchorTags(sConvertLinksToAnchorTags)Sets a new value for property convertLinksToAnchorTags.
setHeight(sHeight)Sets a new value for property height.
setHtmlText(sText)Defines the HTML text to be displayed.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.m.FormattedText(sId?, mSettings?)

Constructor for a new FormattedText.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Method Detail
sap.m.FormattedText.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.FormattedText with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.FormattedText.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.FormattedText.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getConvertedLinksDefaultTarget(): string

Gets current value of property convertedLinksDefaultTarget.

Determines the target attribute of the generated HTML anchor tags.

Note: Applicable only if ConvertLinksToAnchorTags property is used with a value other than sap.m.LinkConversion.None. Options are the standard values for the target attribute of the HTML anchor tag: _self, _top, _blank, _parent, _search.

Default value is _blank.

Returns:
stringValue of property convertedLinksDefaultTarget
Since:
1.45.5
getConvertLinksToAnchorTags(): sap.m.LinkConversion

Gets current value of property convertLinksToAnchorTags.

Determines whether strings that appear to be links will be converted to HTML anchor tags, and what are the criteria for recognizing them.

Default value is None.

Returns:
sap.m.LinkConversionValue of property convertLinksToAnchorTags
Since:
1.45.5
getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Optional height of the control in CSS units.

Returns:
sap.ui.core.CSSSizeValue of property height
getHtmlText(): string

Gets current value of property htmlText.

Text in HTML format. The following tags are supported:

  • a
  • abbr
  • blockquote
  • br
  • cite
  • code
  • em
  • h1
  • h2
  • h3
  • h4
  • h5
  • h6
  • p
  • pre
  • strong
  • span
  • u
  • dl
  • dt
  • dl
  • ul
  • ol
  • li

class, style, and target attributes are allowed. If target is not set, links open in a new window by default.

Only safe href attributes can be used. See jQuery.sap.validateUrl.

Note: Keep in mind that not supported HTML tags and the content nested inside them are both not rendered by the control.

Default value is .

Returns:
stringValue of property htmlText
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Optional width of the control in CSS units.

Returns:
sap.ui.core.CSSSizeValue of property width
setConvertedLinksDefaultTarget(sConvertedLinksDefaultTarget): sap.m.FormattedText

Sets a new value for property convertedLinksDefaultTarget.

Determines the target attribute of the generated HTML anchor tags.

Note: Applicable only if ConvertLinksToAnchorTags property is used with a value other than sap.m.LinkConversion.None. Options are the standard values for the target attribute of the HTML anchor tag: _self, _top, _blank, _parent, _search.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is _blank.

Parameters:
stringsConvertedLinksDefaultTargetNew value for property convertedLinksDefaultTarget
Returns:
sap.m.FormattedTextReference to this in order to allow method chaining
Since:
1.45.5
setConvertLinksToAnchorTags(sConvertLinksToAnchorTags): sap.m.FormattedText

Sets a new value for property convertLinksToAnchorTags.

Determines whether strings that appear to be links will be converted to HTML anchor tags, and what are the criteria for recognizing them.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is None.

Parameters:
sap.m.LinkConversionsConvertLinksToAnchorTagsNew value for property convertLinksToAnchorTags
Returns:
sap.m.FormattedTextReference to this in order to allow method chaining
Since:
1.45.5
setHeight(sHeight): sap.m.FormattedText

Sets a new value for property height.

Optional height of the control in CSS units.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
sap.ui.core.CSSSizesHeightNew value for property height
Returns:
sap.m.FormattedTextReference to this in order to allow method chaining
setHtmlText(sText): sap.m.FormattedText
Defines the HTML text to be displayed.
Parameters:
stringsTextHTML text as a string
Returns:
sap.m.FormattedTextthis for chaining
setWidth(sWidth): sap.m.FormattedText

Sets a new value for property width.

Optional width of the control in CSS units.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.m.FormattedTextReference to this in order to allow method chaining