API Docs for: 0.8.0
Show:

TemplateValue Class

Defined in: include/service/entities/template_service.js:939
Module: Services

A value that has special meaning to TemplateService. It acts as a wrapper for a value to be used in a template along with special processing instructions.

Constructor

TemplateValue

(
  • {val}
  • [htmlEncode=true]
)

Defined in include/service/entities/template_service.js:939

Parameters:

  • {val} String

    The raw value to be included in the template processing

  • [htmlEncode=true] Boolean optional

    Indicates if the value should be encoded during serialization.

Item Index

Methods

Methods

doEncode

()

Defined in include/service/entities/template_service.js:976

Specifies that the value should be encoded for HTML

encode

(
  • [doHtmlEncoding]
)
Boolean

Defined in include/service/entities/template_service.js:955

Encodes the value for an HTML document when a value is provided.

Parameters:

  • [doHtmlEncoding] Boolean optional

    Sets the property to encode the value to HTML

Returns:

Boolean:

The current value of the htmlEncode property

skipEncode

()

Defined in include/service/entities/template_service.js:968

Specifies that the value should not be encoded for HTML

toString

() String

Defined in include/service/entities/template_service.js:997

Overrides the toString function in order to properly serialize the value.

Returns:

String:

A string representation of the value that follows the processing instructions.

val

() String

Defined in include/service/entities/template_service.js:984

Retrieves the processed value represented by this object.

Returns:

String:

The processed value