| Metadata Element | Description |
|---|
| Breadcrumbs | Outputs a breadcrumbs section. The breadcrumbs section is only output if the option is enabled in the
Build Profile editor. |
| BuildProfileName | Outputs the name of the current Project Profile. |
| CascadeSummary | Outputs the CASCADE_UPDATES and/or CASCADE_DELETES template phrases if the current Table has a cascade updates and/or deletes constraint. |
| Charset | Outputs the numeric identifier of the encoding codepage defined in the project. |
| ChildColumn | Returns the child column for the current relationship. |
| ChildTable | Outputs the name of the child Table of the current Relationship. |
| ColumnAllowNulls | Outputs an <img> tag for the tick.gif image if the column allows nulls. |
| ColumnDataType | Outputs the data type caption of the current Column. |
| ColumnDefault | Outputs the default column value. |
| ColumnFormula | Outputs the formula of the column. |
| ColumnIsFloat | Outputs "true" if the column is a float. |
| ColumnLength | Outputs the length of the column. |
| ColumnPrecision | Outputs the column precision. |
| ColumnPrimaryKeyIcon | Outputs an <img> tag for the primarykey.gif image if the column is part of the primary key. |
| ColumnScale | Outputs the column scale. |
| ColumnSortOrder | Outputs the column sort order: "Ascending" or "Descending". |
| CommunityBaseUrl | Outputs the location to which the generated Html will output. This setting is used only if a Community Extensions proxy page is being used. |
| CommunityItemID | Returns the unique Id used by Community Extensions to identify the current item. |
| CommunityProjectKey | Outputs the Community Extensions Project Key defined for this Project. The Project Key is an encoded value based on the
setting defined on the Community Settings page in the Build Profile editor. |
| CommunityProxyTargetUrl | Outputs the address of the Community Extensions proxy page (if one is being used). |
| ContentSection | Add this to a base page type to create a section that can be populated in a derived page type. |
| CrLf | Outputs carriage return and line feed characters. |
| CurrentDatabaseName | Outputs the name of the current Database. |
| CurrentFileNameNoExtension | Outputs the current filename excluding the file extension. |
| CustomHeadContent | Outputs the content of any custom HEAD tag content, as well as Google Analytics script (if enabled) |
| DataTypeProperty | Outputs a property of the current User Defined Data Type. |
| DefaultTopic | Outputs the file name (including extension) of the default Topic. |
| DependencyLevel | Outputs the dependency level of the current item |
| Description | Outputs the summary content for the current item. |
| Designtime | Outputs any content between the start and end DXMETADATA markers at design time, otherwise returns nothing. |
| ExampleCode | Outputs the code for the current Example. |
| ExampleId | Returns a unique id (different for each documentation generation) for the current Example. |
| ExampleLanguage | Outputs the language name of the current Example (e.g. CS). |
| ExampleLanguageCaption | Outputs a readable name for the language of the current example (e.g. C++/CLI). |
| ExampleTitle | Outputs the title of the current Example. |
| FileName | Outputs the filename for the current item. |
| FilteredItemList | Generates output based on a set of child items (of the Item Type identified by the Namespace parameter). The output generated for each item is formatted using the parsed
value of a Scrap named {Scrap}_BODY. The complete output is then prefixed with the parsed value of a Scrap named {Scrap}_HEADER and suffixed with the parsed value
of a Scrap named {Scrap}_FOOTER. No output is generated if no child items are found. |
| GeneralDate | Outputs the current date in General Date format. |
| GroupExamples | Outputs "True" if the option to group examples has been enabled. Otherwise returns nothing. |
| HelpProjectTitle | Outputs the Project Title. |
| IconName | Outputs the name of the icon image file (without path or extension) for the current item. |
| IncludeSchemaInformation | Outputs "True" if the "Include Schema Information" option has been enabled. |
| IndexProperty | Outputs a property of the current Index. |
| IsNew | Outputs True if the current item is new. |
| IsTemplateFileFeatureEnabled | Outputs "True" if the named Template File Feature is enabled or nothing if it is disabled |
| ItemName | Outputs the name of the current item. |
| ItemQualifiedName | Outputs the fully qualified name of the current item. The fully qualified name uniquely identifies the current item. |
| ItemQualifiedName_ScriptSafe | Outputs the qualified name of the current item, with any reserved script characters encoded so the value can be used directly in script. |
| ItemTitle | Outputs a readable title for the current item, e.g. "Add Method". |
| ItemType | Outputs the type of the current item (e.g. "Namespace", "Class" etc.). |
| Link | Outputs an html anchor element for the current item. |
| LinkCategoryName | Outputs the category name for the current See Also link. |
| LinkTarget_ScriptSafe | Outputs the target of the current link, with any reserved script characters encoded so the value can be used directly in script. |
| Literal | Outputs the content of the value parameter. This element can be used in combination with conditions to include/exclude
static content according to particular conditions. |
| LocaleString | Outputs a string identifying the encoding defined in the project (e.g. "0x432 English (United States)"). |
| LocalItemTitle | Outputs a readable title for the current item, e.g. "Add Method". |
| LogoImage | Outputs an <img> tag for the projects logo image. |
| LongDate | Outputs the current date in Long Date format. |
| LongTime | Outputs the current time in Long Time format. |
| MarkOfTheWeb | Outputs <!-- saved from url= --> tag using the URL defined in the Build Profile. |
| MetaCharset | Outputs an Html META element defining the charset to use according to the encoding settings defined in the project. |
| Name | Outputs the name of the current item. |
| ObjectType | Outputs the phrase value for the current item type. |
| OutputFileExtension | Outputs the file extension defined in the project (defaults to .html). |
| PageItemTitle | An alias for LocalItemTitle. The two are equivalent. |
| ParameterDataType | Outputs the data type caption of the current Parameter. |
| ParameterSize | Outputs the defined size of the parameter. |
| ParameterType | Outputs the parameter type. One of: "In", "In/Out", "Out", "Return Value". |
| ParentColumn | Returns the parent column for the current relationship. |
| ParentItemName | Outputs the name of the parent item for the current item. |
| ParentQualifiedName | Outputs the fully qualified name of the parent of the current item. |
| ParentTable | Outputs the name of the parent Table of the current Relationship. |
| PermissionDelete | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the Delete permission. |
| PermissionDRI | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the DRI permission. |
| PermissionExecute | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the Execute permission. |
| PermissionInsert | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the Insert permission. |
| PermissionSelect | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the Select permission. |
| PermissionUpdate | Returns the Scrap _BOOLEAN_PROPERTY_TRUE or _BOOLEAN_PROPERTY_FALSE depending on whether the parent item has the Update permission. |
| Phrase | Outputs a phrase from the Template phrase table according to the current phrase language. |
| PhraseLanguage | Outputs the current Phrase language. |
| ProjectId | Outputs the Id of the current Project. |
| ProjectTitle | Outputs the Project Title. The Project Title is defined in the BuildProfileTerm Editor. |
| PropertyCaption | Outputs the caption for the property. |
| PropertyName | Outputs the name of the property. |
| RelativeFileName | Outputs the filename for the current item, relative to the project file. Use RelativeUrlFileName if you are using this value as a link target rather than a local path and filename, as it replaces \ with /. |
| RelativeUrlFileName | Outputs the filename for the current item, relative to the project file. Any \ characters in the path will be replaced with / so that the value is usable as a relative url. |
| Scrap | Outputs the value of a Scrap defined in the current Template. |
| Scripts | Outputs a <script> element for each script file. |
| ShortDate | Outputs the current date in Short Date format. |
| ShortItemName | Outputs the name of the current item. |
| ShortTime | Outputs the current time in Short Time format. |
| Source | Outputs the SQL source for the current item. |
| StrippedDescription | Outputs the summary content for the current item. |
| Stylesheets | Outputs a <link> element for each stylesheet. |
| TableName | Outputs the name of the parent table of the current item. |
| TableQualifiedName | Outputs the qualified name of the parent table of the current item. |
| TaggedComment | Outputs the content for a particular content type. |
| TypeName | Outputs the name of the current item type - e.g. Class, Namespace etc. |
| UdtBaseType | Outputs the base type name of the current User Defined Data Type. |
| Variable | Outputs the value of a Project or Template property. |
| XmlEncoding | Outputs a string that represents the current output encoding, suitable for including in an Xml file encoding attribute, e.g. "utf-8" |
| Year | Outputs the current year. |