FormattedString | NativeScript

Hierarchy

ViewBase

Implements

Implemented by

FormattedString

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FormattedString(): FormattedString

Inherited from ViewBase.constructor
- Defined in ui/text-base/formatted-string.ts:12
Returns FormattedString

Properties

_automaticallyAdjustsScrollViewInsets

_automaticallyAdjustsScrollViewInsets: boolean

_context

_context: any

_cssState

_cssState: CssState

_defaultPaddingBottom

_defaultPaddingBottom: number

_defaultPaddingLeft

_defaultPaddingLeft: number

_defaultPaddingRight

_defaultPaddingRight: number

_defaultPaddingTop

_defaultPaddingTop: number

_domId

_domId: number

_ignoreFlexMinWidthHeightReset

_ignoreFlexMinWidthHeightReset: boolean

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean

_isPaddingRelative

_isPaddingRelative: boolean

_isStyleScopeHost

_isStyleScopeHost: boolean

_isViewBase

_isViewBase: boolean

_moduleName

_moduleName: string

_oldBottom

_oldBottom: number

_oldLeft

_oldLeft: number

_oldRight

_oldRight: number

_oldTop

_oldTop: number

Private _spans

_spans: ObservableArray<Span>

_styleScope

_styleScope: StyleScope

_suspendNativeUpdatesCount

_suspendNativeUpdatesCount: number

_suspendedUpdates

_suspendedUpdates: object

Type declaration

[propertyName: string]: Property<ViewBase, any> | CssProperty<Style, any> | CssAnimationProperty<Style, any>

alignSelf

alignSelf: AlignSelf

bindingContext

bindingContext: any

className

className: string

col

col: number

colSpan

colSpan: number

column

column: number

columnSpan

columnSpan: number

cssClasses

cssClasses: Set<string>

cssPseudoClasses

cssPseudoClasses: Set<string>

dock

dock: "left" | "right" | "top" | "bottom"

domNode

domNode: DOMNode

effectiveBorderBottomWidth

effectiveBorderBottomWidth: number

effectiveBorderLeftWidth

effectiveBorderLeftWidth: number

effectiveBorderRightWidth

effectiveBorderRightWidth: number

effectiveBorderTopWidth

effectiveBorderTopWidth: number

effectiveHeight

effectiveHeight: number

effectiveLeft

effectiveLeft: number

effectiveMarginBottom

effectiveMarginBottom: number

effectiveMarginLeft

effectiveMarginLeft: number

effectiveMarginRight

effectiveMarginRight: number

effectiveMarginTop

effectiveMarginTop: number

effectiveMinHeight

effectiveMinHeight: number

effectiveMinWidth

effectiveMinWidth: number

effectivePaddingBottom

effectivePaddingBottom: number

effectivePaddingLeft

effectivePaddingLeft: number

effectivePaddingRight

effectivePaddingRight: number

effectivePaddingTop

effectivePaddingTop: number

effectiveTop

effectiveTop: number

effectiveWidth

effectiveWidth: number

flexGrow

flexGrow: number

flexShrink

flexShrink: number

flexWrapBefore

flexWrapBefore: boolean

id

id: string

isCollapsed

isCollapsed: any

left

left: Length

nativeViewProtected

nativeViewProtected: any

order

order: number

parent

parent: ViewBase

recycleNativeView

recycleNativeView: "auto" | "always" | "never"

row

row: number

rowSpan

rowSpan: number

top

top: Length

viewController

viewController: any

Static createdEvent

createdEvent: string

Static loadedEvent

loadedEvent: string

Static propertyChangeEvent

propertyChangeEvent: string

Static unloadedEvent

unloadedEvent: string

Accessors

android

get (): any

- Defined in ui/core/view-base/index.ts:349
Returns any

backgroundColor

get (): Color
set (value: Color): void

- Defined in ui/text-base/formatted-string.ts:62
Returns Color
- Defined in ui/text-base/formatted-string.ts:65
Parameters
- value: Color
Returns void

class

get (): string
set (v: string): void

- Defined in ui/core/view-base/index.ts:363
Returns string
- Defined in ui/core/view-base/index.ts:366
Parameters
- v: string
Returns void

color

get (): Color
set (value: Color): void

- Defined in ui/text-base/formatted-string.ts:55
Returns Color
- Defined in ui/text-base/formatted-string.ts:58
Parameters
- value: Color
Returns void

fontFamily

get (): string
set (value: string): void

- Defined in ui/text-base/formatted-string.ts:20
Returns string
- Defined in ui/text-base/formatted-string.ts:23
Parameters
- value: string
Returns void

fontStyle

get (): FontStyle
set (value: FontStyle): void

- Defined in ui/text-base/formatted-string.ts:34
Returns FontStyle
- Defined in ui/text-base/formatted-string.ts:37
Parameters
- value: FontStyle
Returns void

fontWeight

get (): FontWeight
set (value: FontWeight): void

- Defined in ui/text-base/formatted-string.ts:41
Returns FontWeight
- Defined in ui/text-base/formatted-string.ts:44
Parameters
- value: FontWeight
Returns void

ios

get (): any

- Defined in ui/core/view-base/index.ts:354
Returns any

isLoaded

get (): boolean

- Defined in ui/core/view-base/index.ts:359
Returns boolean

nativeView

get (): any
set (value: any): void

- Defined in ui/core/view-base/index.ts:325
Returns any
- Defined in ui/core/view-base/index.ts:329
Parameters
- value: any
Returns void

parentNode

get (): ViewBase
set (node: ViewBase): void

- Defined in ui/core/view-base/index.ts:318
Returns ViewBase
- Defined in ui/core/view-base/index.ts:321
Parameters
- node: ViewBase
Returns void

spans

get (): ObservableArray<Span>

- Defined in ui/text-base/formatted-string.ts:69
Returns ObservableArray<Span>

style

get (): Style
set (inlineStyle: Style): void

- Defined in ui/core/view-base/index.ts:338
Returns Style
- Defined in ui/core/view-base/index.ts:341
Parameters
- inlineStyle: Style
Returns void

textDecoration

get (): TextDecoration
set (value: TextDecoration): void

- Defined in ui/text-base/formatted-string.ts:48
Returns TextDecoration
- Defined in ui/text-base/formatted-string.ts:51
Parameters
- value: TextDecoration
Returns void

typeName

get (): string

- Defined in ui/core/view-base/index.ts:334
Returns string

Methods

_addArrayFromBuilder

_addArrayFromBuilder(name: string, value: any[]): void

Implementation of AddArrayFromBuilder._addArrayFromBuilder
- Defined in ui/text-base/formatted-string.ts:86
A function that is called when an array declaration is found in xml.

Parameters
- name: string
- value: any[]
Returns void

_addChildFromBuilder

_addChildFromBuilder(name: string, value: any): void

Implementation of AddChildFromBuilder._addChildFromBuilder
- Defined in ui/text-base/formatted-string.ts:92
Called for every child element declared in xml. This method will add a child element (value) to current element.

Parameters
- name: string
- value: any
Returns void

_addView

_addView(view: ViewBase, atIndex?: number): void

Inherited from ViewBase._addView
- Defined in ui/core/view-base/index.ts:642
Parameters
- view: ViewBase
- Optional atIndex: number
Returns void

_addViewCore

_addViewCore(view: ViewBase, atIndex?: number): void

Inherited from ViewBase._addViewCore
- Defined in ui/core/view-base/index.ts:666
Parameters
- view: ViewBase
- Optional atIndex: number
Returns void

_addViewToNativeVisualTree

_addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean

Inherited from ViewBase._addViewToNativeVisualTree
- Defined in ui/core/view-base/index.ts:925
Method is intended to be overridden by inheritors and used as "protected".

Parameters
- view: ViewBase
- Optional atIndex: number
Returns boolean

_applyXmlAttribute

_applyXmlAttribute(attribute: string, value: string): boolean

Inherited from ViewBase._applyXmlAttribute
- Defined in ui/core/view-base/index.ts:960
deprecated

This used to be the way to set attribute values in early {N} versions. Now attributes are expected to be set as plain properties on the view instances.

Parameters
- attribute: string
- value: string
Returns boolean

_batchUpdate

_batchUpdate<T>(callback: function): T

Inherited from ViewBase._batchUpdate
- Defined in ui/core/view-base/index.ts:463
Type parameters
- T
Parameters
- callback: function
  - - (): T
    - Returns T
Returns T

_childIndexToNativeChildIndex

_childIndexToNativeChildIndex(index?: number): number

Inherited from ViewBase._childIndexToNativeChildIndex
- Defined in ui/core/view-base/index.ts:918
Parameters
- Optional index: number
Returns number

_createPropertyChangeData

_createPropertyChangeData(propertyName: string, value: any, oldValue?: any): PropertyChangeData

Inherited from ViewBase._createPropertyChangeData
- Defined in data/observable/index.ts:309
Parameters
- propertyName: string
- value: any
- Optional oldValue: any
Returns PropertyChangeData

_dialogClosed

_dialogClosed(): void

Inherited from ViewBase._dialogClosed
- Defined in ui/core/view-base/index.ts:1056
Returns void

_emit

_emit(eventNames: string): void

Inherited from ViewBase._emit
- Defined in data/observable/index.ts:319
Parameters
- eventNames: string
Returns void

_goToVisualState

_goToVisualState(state: string): void

Inherited from ViewBase._goToVisualState
- Defined in ui/core/view-base/index.ts:940
Parameters
- state: string
Returns void

_inheritStyleScope

_inheritStyleScope(styleScope: StyleScope): void

Inherited from ViewBase._inheritStyleScope
- Defined in ui/core/view-base/index.ts:1025
Parameters
- styleScope: StyleScope
Returns void

_layoutParent

_layoutParent(): void

Inherited from ViewBase._layoutParent
- Defined in ui/core/view-base/index.ts:435
Returns void

_onCssStateChange

_onCssStateChange(): void

Inherited from ViewBase._onCssStateChange
- Defined in ui/core/view-base/index.ts:1016
Returns void

_onRootViewReset

_onRootViewReset(): void

Inherited from ViewBase._onRootViewReset
- Defined in ui/core/view-base/index.ts:1064
Returns void

_parentChanged

_parentChanged(oldParent: ViewBase): void

Inherited from ViewBase._parentChanged
- Defined in ui/core/view-base/index.ts:981
Parameters
- oldParent: ViewBase
Returns void

_removeView

_removeView(view: ViewBase): void

Inherited from ViewBase._removeView
- Defined in ui/core/view-base/index.ts:699
Core logic for removing a child view from this instance. Used by the framework to handle lifecycle events more centralized. Do not use outside the UI Stack implementation.

Parameters
- view: ViewBase
Returns void

_removeViewCore

_removeViewCore(view: ViewBase): void

Inherited from ViewBase._removeViewCore
- Defined in ui/core/view-base/index.ts:720
Method is intended to be overridden by inheritors and used as "protected"

Parameters
- view: ViewBase
Returns void

_removeViewFromNativeVisualTree

_removeViewFromNativeVisualTree(view: ViewBase): void

Inherited from ViewBase._removeViewFromNativeVisualTree
- Defined in ui/core/view-base/index.ts:936
Method is intended to be overridden by inheritors and used as "protected"

Parameters
- view: ViewBase
Returns void

_resumeNativeUpdates

_resumeNativeUpdates(type: SuspendType): void

Inherited from ViewBase._resumeNativeUpdates
- Defined in ui/core/view-base/index.ts:448
Parameters
- type: SuspendType
Returns void

_setupAsRootView

_setupAsRootView(context: any): void

Inherited from ViewBase._setupAsRootView
- Defined in ui/core/view-base/index.ts:763
Parameters
- context: any
Returns void

_setupUI

_setupUI(context: any, atIndex?: number, parentIsLoaded?: boolean): void

Inherited from ViewBase._setupUI
- Defined in ui/core/view-base/index.ts:768
Parameters
- context: any
- Optional atIndex: number
- Optional parentIsLoaded: boolean
Returns void

_shouldDelayLayout

_shouldDelayLayout(): boolean

Inherited from ViewBase._shouldDelayLayout
- Defined in ui/core/view-base/index.ts:686
Returns boolean

_suspendNativeUpdates

_suspendNativeUpdates(type: SuspendType): void

Inherited from ViewBase._suspendNativeUpdates
- Defined in ui/core/view-base/index.ts:441
Parameters
- type: SuspendType
Returns void

_tearDownUI

_tearDownUI(force?: boolean): void

Inherited from ViewBase._tearDownUI
- Defined in ui/core/view-base/index.ts:862
Parameters
- Optional force: boolean
Returns void

addEventListener

addEventListener(eventNames: string, callback: function, thisArg?: any): void

Inherited from ViewBase.addEventListener
- Defined in data/observable/index.ts:105
Parameters
- eventNames: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

Private addPropertyChangeHandler

addPropertyChangeHandler(span: Span): void

- Defined in ui/text-base/formatted-string.ts:128
Parameters
- span: Span
Returns void

addPseudoClass

addPseudoClass(name: string): void

Inherited from ViewBase.addPseudoClass
- Defined in ui/core/view-base/index.ts:535
Parameters
- name: string
Returns void

bind

bind(options: BindingOptions, source?: Object): void

Inherited from ViewBase.bind
- Defined in ui/core/view-base/index.ts:564
Parameters
- options: BindingOptions
- source: Object = ...
Returns void

callLoaded

callLoaded(): void

Inherited from ViewBase.callLoaded
- Defined in ui/core/view-base/index.ts:503
Returns void

callUnloaded

callUnloaded(): void

Inherited from ViewBase.callUnloaded
- Defined in ui/core/view-base/index.ts:507
Returns void

closeModal

closeModal(...args: any[]): void

Inherited from ViewBase.closeModal
- Defined in ui/core/view-base/index.ts:1049
Parameters
- Rest ...args: any[]
Returns void

createNativeView

createNativeView(): Object

Inherited from ViewBase.createNativeView
- Defined in ui/core/view-base/index.ts:728
Returns Object

deletePseudoClass

deletePseudoClass(name: string): void

Inherited from ViewBase.deletePseudoClass
- Defined in ui/core/view-base/index.ts:546
Parameters
- name: string
Returns void

disposeNativeView

disposeNativeView(): void

Inherited from ViewBase.disposeNativeView
- Defined in ui/core/view-base/index.ts:732
Returns void

eachChild

eachChild(callback: function): void

Overwrites ViewBase.eachChild
- Defined in ui/text-base/formatted-string.ts:156
Parameters
- callback: function
  - - (child: ViewBase): boolean
    - Parameters
      - child: ViewBase
      Returns boolean
Returns void

ensureDomNode

ensureDomNode(): void

Inherited from ViewBase.ensureDomNode
- Defined in ui/core/view-base/index.ts:382
Returns void

get

get(name: string): any

Inherited from ViewBase.get
- Defined in data/observable/index.ts:52
Parameters
- name: string
Returns any

getViewById

getViewById<T>(id: string): T

Inherited from ViewBase.getViewById
- Defined in ui/core/view-base/index.ts:370
Type parameters
- T: ViewBase<T>
Parameters
- id: string
Returns T

hasListeners

hasListeners(eventName: string): boolean

Inherited from ViewBase.hasListeners
- Defined in data/observable/index.ts:305
Parameters
- eventName: string
Returns boolean

initNativeView

initNativeView(): void

Inherited from ViewBase.initNativeView
- Defined in ui/core/view-base/index.ts:736
Returns void

loadView

loadView(view: ViewBase): void

Inherited from ViewBase.loadView
- Defined in ui/core/view-base/index.ts:680
Parameters
- view: ViewBase
Returns void

notify

notify<T>(data: T): void

Inherited from ViewBase.notify
- Defined in data/observable/index.ts:270
Type parameters
- T: NotifyData<T>
Parameters
- data: T
Returns void

notifyPropertyChange

notifyPropertyChange(name: string, value: any, oldValue?: any): void

Inherited from ViewBase.notifyPropertyChange
- Defined in data/observable/index.ts:301
Parameters
- name: string
- value: any
- Optional oldValue: any
Returns void

off

off(eventNames: string, callback?: any, thisArg?: any): void

Inherited from ViewBase.off
- Defined in data/observable/index.ts:101
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

on

on(eventNames: string, callback: function, thisArg?: any): void

Inherited from ViewBase.on
- Defined in data/observable/index.ts:84
Parameters
- eventNames: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

onLoaded

onLoaded(): void

Inherited from ViewBase.onLoaded
- Defined in ui/core/view-base/index.ts:396
Returns void

Private onPropertyChange

onPropertyChange(data: PropertyChangeData): void

- Defined in ui/text-base/formatted-string.ts:152
Parameters
- data: PropertyChangeData
Returns void

onResumeNativeUpdates

onResumeNativeUpdates(): void

Inherited from ViewBase.onResumeNativeUpdates
- Defined in ui/core/view-base/index.ts:996
Returns void

Private onSpansCollectionChanged

onSpansCollectionChanged(eventData: ChangedData<Span>): void

- Defined in ui/text-base/formatted-string.ts:98
Parameters
- eventData: ChangedData<Span>
Returns void

onUnloaded

onUnloaded(): void

Inherited from ViewBase.onUnloaded
- Defined in ui/core/view-base/index.ts:416
Returns void

once

once(event: string, callback: function, thisArg?: any): void

Inherited from ViewBase.once
- Defined in data/observable/index.ts:88
Parameters
- event: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

removeEventListener

removeEventListener(eventNames: string, callback?: any, thisArg?: any): void

Inherited from ViewBase.removeEventListener
- Defined in data/observable/index.ts:126
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

Private removePropertyChangeHandler

removePropertyChangeHandler(span: Span): void

- Defined in ui/text-base/formatted-string.ts:140
Parameters
- span: Span
Returns void

requestLayout

requestLayout(): void

Inherited from ViewBase.requestLayout
- Defined in ui/core/view-base/index.ts:629
Returns void

resetNativeView

resetNativeView(): void

Inherited from ViewBase.resetNativeView
- Defined in ui/core/view-base/index.ts:740
Returns void

set

set(name: string, value: any): void

Inherited from ViewBase.set
- Defined in ui/core/view-base/index.ts:391
Parameters
- name: string
- value: any
Returns void

setInlineStyle

setInlineStyle(style: string): void

Inherited from ViewBase.setInlineStyle
- Defined in ui/core/view-base/index.ts:972
Parameters
- style: string
Returns void

setNativeView

setNativeView(value: any): void

Inherited from ViewBase.setNativeView
- Defined in ui/core/view-base/index.ts:843
Parameters
- value: any
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from ViewBase.setProperty
- Defined in data/observable/index.ts:68
Parameters
- name: string
- value: any
Returns void

showModal

showModal(...args: any[]): ViewBase

Inherited from ViewBase.showModal
- Defined in ui/core/view-base/index.ts:1043
Parameters
- Rest ...args: any[]
Returns ViewBase

toString

toString(): string

Overwrites ViewBase.toString
- Defined in ui/text-base/formatted-string.ts:77
Returns string

unbind

unbind(property: string): void

Inherited from ViewBase.unbind
- Defined in ui/core/view-base/index.ts:593
Parameters
- property: string
Returns void

unloadView

unloadView(view: ViewBase): void

Inherited from ViewBase.unloadView
- Defined in ui/core/view-base/index.ts:690
Parameters
- view: ViewBase
Returns void

Static addEventListener

addEventListener(eventName: string, callback: any, thisArg?: any): void

Inherited from ViewBase.addEventListener
- Defined in data/observable/index.ts:231
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static off

off(eventName: string, callback?: any, thisArg?: any): void

Inherited from ViewBase.off
- Defined in data/observable/index.ts:179
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Static on

on(eventName: string, callback: any, thisArg?: any): void

Inherited from ViewBase.on
- Defined in data/observable/index.ts:156
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static once

once(eventName: string, callback: any, thisArg?: any): void

Inherited from ViewBase.once
- Defined in data/observable/index.ts:160
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static removeEventListener

removeEventListener(eventName: string, callback?: any, thisArg?: any): void

Inherited from ViewBase.removeEventListener
- Defined in data/observable/index.ts:183
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Class FormattedString

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FormattedString

Properties

_automaticallyAdjustsScrollViewInsets

_context

_cssState

_defaultPaddingBottom

_defaultPaddingLeft

_defaultPaddingRight

_defaultPaddingTop

_domId

_ignoreFlexMinWidthHeightReset

_isAddedToNativeVisualTree

_isPaddingRelative

_isStyleScopeHost

_isViewBase

_moduleName

_oldBottom

_oldLeft

_oldRight

_oldTop

Private _spans

_styleScope

_suspendNativeUpdatesCount

_suspendedUpdates

Type declaration

[propertyName: string]: Property<ViewBase, any> | CssProperty<Style, any> | CssAnimationProperty<Style, any>

alignSelf

bindingContext

className

col

colSpan

column

columnSpan

cssClasses

cssPseudoClasses

dock

domNode

effectiveBorderBottomWidth

effectiveBorderLeftWidth

effectiveBorderRightWidth

effectiveBorderTopWidth

effectiveHeight

effectiveLeft

effectiveMarginBottom

effectiveMarginLeft

effectiveMarginRight

effectiveMarginTop

effectiveMinHeight

effectiveMinWidth

effectivePaddingBottom

effectivePaddingLeft

effectivePaddingRight

effectivePaddingTop

effectiveTop

effectiveWidth

flexGrow

flexShrink

flexWrapBefore

id

isCollapsed

left

nativeViewProtected

order

parent

recycleNativeView

row

rowSpan

top

viewController