Tinderbox v9 Icon

document.keys()


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

 Function  [other Function type actions]

 Document  [operators of similar scope]

 Document configuration  [other Document configuration operators]

 Baseline

 As at baseline


Syntax note: Operators without any defined mandatory arguments may omit their empty closing parentheses


document.keys()

document.keys

returns a list of the document() dictionary's keys of useful properties of the current document. The operator returns the document Dictionary object as a single string, noting that no operator trailing parentheses are needed:

$MyList = document.keys; 

The returned list is in the dictionary's stored order as listed for document().

The document.keys operator can assist in getting a readable output of all the keys and their values

	$Text =;
	document.keys.each(aKey){
		var:list vKey = document[aKey];
		$Text += aKey + ": " + vKey.format(", ") +"\n\n";
	};

which will list in $Text of the current note each key name and then its value with a blank line in between. For multi-item values like user-attributes and link-types list formatting applies a ', ' delimiter for legibility.