Document! X and HelpStudio 2019
In This Topic
    Keyword Metadata Element
    In This Topic
    Description
    Outputs a language keyword for a particular item.
    Usage

    This Metadata Element can only be used in Page Types or Scraps that relate to the COM Component Documentation Item Types listed below. (more info)

    • Structure
    • Enumeration
    • Method
    • Property
    • Event
    • Parameter
    Use in Page Types or scraps that do not relate to these specific Item Types may result in unexpected output or documentation build errors.
    Parameters
    ParameterTypeDescription
    langThe language for which the keyword should be returned (e.g. "cs", "vb").
    booleanSet to True to prevent a space from being output before the keyword.
    list 

    One of the following values:

    For overloadable members only. Returns the language specific keyword that indicates a member is abstract (e.g. abstract in csharp).
    For Parameter only. Returns the language specific text that indicates an array (e.g. [] in csharp).
    For Parameter only. Returns the language specific keyword that indicates a parameter is passed by reference (e.g. ref in csharp).
    For Parameter only. Returns the language specific keyword that indicates a Parameter Array parameter.
    For Parameter only. Returns the language specific keyword that indicates a parameter is marked as an out parameter (e.g. out in csharp).
    For types, returns the language specific keyword that indicates a type is abstract (e.g. abstract in csharp).
    For types, returns the language specific keyword that indicates a type cannot be inherited (e.g. sealed in csharp).
    For overloadable members only. Returns the language specific keword that indicates a member is not overridable (e.g. sealed in csharp).
    For overloadable members only. Returns the language specific keyword that indicates a member is an overload (e.g. overloads in csharp).
    For overloadable members only. Returns the language specific keyword that indicates a member overrides a base implementation (e.g. overrides in csharp).
    For Parameter only. Returns the language specific keyword that indicates a Parameter Array parameter (e.g. ParamArrary in Visual Basic).
    For members. Returns the language specific keyword that indicates a member shadows a base member (e.g. new in csharp).
    For members and types. Returns the language specific keyword that indicates a member is static (e.g. static in csharp).
    For types, returns the language specific keyword that indicates a type is static (e.g. static in csharp).
    For overloadable members only. Returns the language specific keyword that indicates a member is virtual (e.g. virtual in csharp).
    Remarks
    Keywords are only returned when they are applicable to the item. i.e. the OVERLOADS keyword would only return a value if the item is actually an overload.