Clarion Community Help

Navigation: Templates > Template Language Reference > Template Symbols > Built-in Symbols >====== Symbols Dependent on %Key and %KeyOrder ======

%Key	The labels of all keys and indexes for the file. Multi-valued.
%KeyIdent	The internal key number assigned by the Dictionary Editor and displayed in the IDENT in a .TXD file.
%KeyDescription	A short description of the key.
%KeyLongDesc	A long description of the key.
%KeyFile	The label of the file to which the key belongs.
%KeyID	The label of the key (without prefix).
%KeyIndex	Contains KEY, INDEX, or DYNAMIC.
%KeyName	Contents of the key's NAME attribute.
%KeyAuto	Contains the label of the auto-incrementing field.
%KeyDuplicate	Contains 1 if the key has the DUP attribute.
%KeyExcludeNulls	Contains 1 if the key has the OPT attribute.
%KeyNoCase	Contains 1 if the key has the NOCASE attribute.
%KeyPrimary	Contains 1 if the key is the file's primary key.
%KeyStruct	The key's declaration statement (label and all attributes).
%KeyStatement	The key's attributes (only).
%KeyField	The labels of all component fields of the key. Multi-valued.
%KeyFieldSequence	Contains ASCENDING or DESCENDING. Dependent on %Keyfield.
%KeyQuickOptions	A comma-delimited string containing the choices the user made on the Options tab for the key.
%KeyUserOptions	A string containing the entries the user made in the User Options text box on the Options tab for the key.
%KeyToolOptions	A string containing the entries third-party tools have made in the TOOLOPTIONS section of the .TXD file for the key.
%KeyOrder	The labels of all keys, indexes, and orders for the file. Multi-valued.
%KeyOrderIdent	The internal key number assigned by the Dictionary Editor and displayed in the IDENT in a .TXD file.
%KeyOrderDescription	A short description of the key.
%KeyOrderLongDesc	A long description of the key.
%KeyOrderFile	The label of the file to which the key belongs.
%KeyOrderID	The label of the key (without prefix).
%KeyOrderIndex	Contains KEY, INDEX, or DYNAMIC.
%KeyOrderName	Contents of the key's NAME attribute.
%KeyOrderAuto	Contains the label of the auto-incrementing field.
%KeyOrderDuplicate	Contains 1 if the key has the DUP attribute.
%KeyOrderExcludeNulls	Contains 1 if the key has the OPT attribute.
%KeyOrderNoCase	Contains 1 if the key has the NOCASE attribute.
%KeyOrderPrimary	Contains 1 if the key is the file's primary key.
%KeyOrderStruct	The key's declaration statement (label and all attributes).
%KeyOrderStatement	The key's attributes (only).
%KeyOrderQuickOptions	A comma-delimited string containing the choices the user made on the Options tab for the key.
%KeyOrderUserOptions	A string containing the entries the user made in the User Options text box on the Options tab for the key.
%KeyOrderToolOptions	A string containing the entries third-party tools have made in the TOOLOPTIONS section of the .TXD file for the key.