JsDoc Reference - TagParts

Namespace TagParts

Namespace Summary
Constructor Attributes	Constructor Name and Description
	TagParts Functions to access and modify various tag part types.

Method Summary
Method Attributes	Method Name and Description
<static>	TagParts.BOOLEAN(part, value) Gets or sets the value of a BOOLEAN tag part.
<static>	TagParts.CMSFORM(part, value) Gets or sets the value of a CMSFORM tag part.
<static>	TagParts.DATASOURCE(part, value) Gets or sets the value of a DATASOURCE tag part.
<static>	TagParts.FILE(part, value)
<static>	TagParts.FOLDER(part, value)
<static>	TagParts.FORM(part, value) Gets or sets the value of a FORM tag part.
<static>	TagParts.get(part, value) Gets the value of the given tag part.
<static>	TagParts.IMAGE(part, value)
<static>	TagParts.LIST(part, value) Gets or sets the value of a LIST tag part.
<static>	TagParts.MULTISELECT(part, value) Gets or sets the value of a MULTISELECT tag part.
<static>	TagParts.NODE(part, value) Gets or sets the value of a NODE tag part.
<static>	TagParts.ORDEREDLIST(part, value) Gets or sets the value of a ORDEREDLIST tag part.
<static>	TagParts.OVERVIEW(part, value) Gets or sets the value of an OVERVIEW tag part.
<static>	TagParts.PAGE(part, value) Gets or sets the value of a PAGE tag part.
<static>	TagParts.PAGETAG(part, value) Gets or sets the value of a PAGETAG tag part.
<static>	TagParts.RICHTEXT(part, value) Gets or sets the value of a RICHTEXT tag part.
<static>	TagParts.SELECT(part, value) Gets or sets the value of a SELECT tag part.
<static>	TagParts.set(part, value) Sets the value of the given tag part.
<static>	TagParts.STRING(part, value) Gets or sets the value of a STRING tag part.
<static>	TagParts.TEMPLATETAG(part, value) Gets or sets the value of a TEMPLATETAG tag part.
<static>	TagParts.UNORDEREDLIST(part, value) Gets or sets the value of a UNORDEREDLIST tag part.

Namespace Detail

TagParts

Functions to access and modify various tag part types.

IMPORTANT: Getter and setters for the various part types should never be accessed directly. If absolutely necessary it should be done via TagParts.get and TagParts.set.

Method Detail

{boolean} TagParts.BOOLEAN(part, value)

Gets or sets the value of a BOOLEAN tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{boolean=} value: Optional. The value to set for this part.

Returns:: {boolean} The value held by this part.

{number} TagParts.CMSFORM(part, value)

Gets or sets the value of a CMSFORM tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{number=} value: Optional. The value to set for this part.

Returns:: {number} The value held by this part.

{object} TagParts.DATASOURCE(part, value)

Gets or sets the value of a DATASOURCE tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: An object containing the property 'options'

Returns:: {object} An object containing a copy of the value of this part.

TagParts.FILE(part, value)

Parameters:
part
value

TagParts.FOLDER(part, value)

Parameters:
part
value

{string} TagParts.FORM(part, value)

Gets or sets the value of a FORM tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{string=} value: Optional. The value to set for this part.

Returns:: {string} The value held by this part.

{*} TagParts.get(part, value)

Gets the value of the given tag part.

Parameters:
{object} part: The part whose value is to be retrieved.
{*=} value: The value to set the part to.

Throws:
: CANNOT_READ_TAG_PART

Returns:: {*} The value held in the given part.

TagParts.IMAGE(part, value)

Parameters:
part
value

{object} TagParts.LIST(part, value)

Gets or sets the value of a LIST tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{(string|string[]|object|boolean|null)=} value: A string or string[] to set the listed values, or a boolean to set the 'ordered' flag or an object with the properties 'booleanValue' and/or 'stringValues'

Returns:: {object} An object containing a copy of the value of this part.

{object} TagParts.MULTISELECT(part, value)

Gets or sets the value of a MULTISELECT tag part. Operates in the same was as TagParts.SELECT.

Parameters:
{object} part: The part whose value is to be accessed.
{(string|string[]|object|null)=} value: The values with which to determined what this part's `selectedOptions' property should hold.

Returns:: {object} An object containing a copy of the value of this part.

{number} TagParts.NODE(part, value)

Gets or sets the value of a NODE tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{number=} value: Optional. The value to set for this part.

Returns:: {number} The value held by this part.

{object} TagParts.ORDEREDLIST(part, value)

Gets or sets the value of a ORDEREDLIST tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: A string or string[] to set the listed values or an object with the property 'stringValues'

Returns:: {object} An object containing a copy of the value of this part.

{object} TagParts.OVERVIEW(part, value)

Gets or sets the value of an OVERVIEW tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: Optional. The value to set for this part.

Returns:: {object} The value held by this part.

{number|string} TagParts.PAGE(part, value)

Gets or sets the value of a PAGE tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{(number|string)=} value: Optional. A number denotes and internal page within Content.Node, whereas a string denotes an external url.

Returns:: {number|string} The value held by this part.

{object} TagParts.PAGETAG(part, value)

Gets or sets the value of a PAGETAG tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: An object with the the property `pageId' and/or one of `contentTagId' or `templateTagId'.

Returns:: {object} An object containing a copy of the value of this part.

{string} TagParts.RICHTEXT(part, value)

Gets or sets the value of a RICHTEXT tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{string=} value: Optional. The value to set for this part.

Returns:: {string} The value held by this part.

{object} TagParts.SELECT(part, value)

Gets or sets the value of a SELECT tag part.

There are several possible values that can be passed to this function:

     undefined : When value arguments is not provided, then none of this
                 part's data is changed.

          null : selectedOptions will set to an empty array.

        object : selectedOptions will be set to contain a single select
                 option that corresponds with that of the
                 `selectedOptions' property in the given object.  This
                 allowance exists for backwards compatibility, and is not
                 recommended.

        string : selectedOptions will be set to contain a single select
                 option whose `value' property corresponds with that of
                 the argument.

      string[] : selectedOptions will be set to contain zero or more
                 select option whose `value' property corresponds with
                 that of those in the given array.

Parameters:
{object} part: The part whose value is to be accessed.
{(string|string[]|object|null)=} value: The values with which to determined what this part's `selectedOptions' property should hold.

Throws:
: VALUE_DOES_NOT_EXIST

Returns:: {object} An object containing a copy of the value of this part.

{*} TagParts.set(part, value)

Sets the value of the given tag part.

Parameters:
{object} part: The part whose value is to be set.
{*=} value: The value to set the part to.

Throws:
: CANNOT_READ_TAG_PART

Returns:: {*} The value set to the given part.

{string} TagParts.STRING(part, value)

Gets or sets the value of a STRING tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{string=} value: Optional. The value to set for this part.

Returns:: {string} The value held by this part.

{object} TagParts.TEMPLATETAG(part, value)

Gets or sets the value of a TEMPLATETAG tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: An object with the either the property `templateId' or `templateTagId'.

Returns:: {object} An object containing a copy of the value of this part.

{object} TagParts.UNORDEREDLIST(part, value)

Gets or sets the value of a UNORDEREDLIST tag part.

Parameters:
{object} part: The part whose value is to be accessed.
{object=} value: A string or string[] to set the listed values or an object with the property 'stringValues'

Returns:: {object} An object containing a copy of the value of this part.

Gentics Content.Node JavaScript API

Classes