Summary
Identifies the configurable attributes of the module. This table is
not merged into the database.
More information is available here.
Parameters
Attribute |
Type |
Description |
Required |
name |
string |
Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table. |
True |
format |
msi:MSMModuleConfigurationFormat |
Specifies the format of the data being changed
- text
- key
- integer
- bitfield
|
True |
type |
string |
Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute. |
False |
contextdata |
string |
Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes. |
False |
defaultvalue |
string |
Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally. Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state. |
False |
attr |
int |
Bit field containing attributes for this configurable item. Null is equivalent to 0.
DescriptionThis attribute only applies to records that list a foreign key to a module table in their DefaultValue field.When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types.
|
False |
displayname |
string |
Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI. |
False |
description |
string |
Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform. |
False |
helplocation |
string |
Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available. |
False |
helpkeyword |
string |
Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute. |
False |
Syntax
[BuildElement("moduleconfigurations", ProcessXml = false)]
public SchemaElement[] MsmModuleConfigurationsElement { get; set; }
Attributes
Type |
Description |
BuildElement |
|
Value
Type |
Description |
SchemaElement[] |
|