K4 ServerK4Query

K4 Query

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the K4Query within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4Description string K4 Description read-only
k4GlobalForSectionId string K4 Global For Section ID read-only
k4Id string K4 Server ID read-only
k4IsGlobal bool K4 Is Global read-only
k4MayDelete bool K4 May Delete read-only
k4MayEdit bool K4 May Edit read-only
k4MenuName string K4 Menu Name read-only
k4Name string K4 Name read-only
k4OwnerId string K4 Owner ID read-only
k4PublicationId string K4 Publication ID read-only
parent K4Publication The parent of the K4Query (a K4Publication). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
 → EventListener
getElements(
)
 → K4Query
removeEventListener(
eventType, handler ​[, captures])
 → bool
toSource(
)
 → string
toSpecifier(
)
 → string
addEventListener(
eventType, handler ​[, captures=false])
 → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
 → K4Query
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
 → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
 → string
Generates a string which, if executed, will return the K4Query.
toSpecifier(
)
 → string
Retrieves the object specifier.