Gentics Content.Node JavaScript API

Classes

• _global_
• AdminAPI
• ContentObjectAPI
• FileAPI
• FolderAPI
• GCN
• GCNError
• ImageAPI
• MessageAPI
• NodeAPI
• PageAPI
• TagAPI
• TagContainerAPI
• TagParts
• TemplateAPI

Namespace TagParts

Defined in: tagparts.js.

Method Detail

{boolean} TagParts.BOOLEAN(part, value)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

     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)

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)

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)

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)

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.