DescriptionEntry Complex Type Complex Type
Defines the elements used to create a description of an SDM member.
<xs:complexType name="DescriptionEntry"
mixed="true"
>
<xs:attribute name="Name"
type="string"
use="required"
/>
<xs:attribute name="ResourceId"
type="string"
use="optional"
/>
<xs:attribute name="Manager"
type="QualifiedName"
use="optional"
/>
<xs:attribute name="Substitute"
type="PathList"
use="optional"
/>
</xs:complexType>
Attributes
Name | Type | Description |
---|---|---|
Manager | QualifiedName | The document for the localized text associated with the description, provided for the runtime. |
Name | string | More information about the description. For example, "ErrorDescription", "Category", or "DisplayName". |
ResourceId | string | A resource identifier. To support localization of the description text, a resource identifier can be provided. |
Substitute | PathList | Setting values from the current execution that can be substituted into the error string. |
Example Code [XML]
The following example shows a description entry for a constraint. The error message substitutes several values from the constraint context into the message. The message will be retrieved from the SystemManager using the resource identifier "Findmember.FindHost.ErrorDescription" if the user interface culture does not match the .sdm file language (DocumentLanguage attribute on the <SystemDefinitionModel> element).
<Description>
<Entry Name="ErrorDescription"
Substitute="InstanceName
Guest.InstanceName
FindGuestParent.Parent.InstanceName"
Manager="SystemManager"
ResourceId="FindMember.FindHost.ErrorDescription"
>
The hosting relationship {0} targets a host that is not within
the allowed scope for this relationship. The host for
instance {1} must be contained by the host for
instance {2}.</Entry>
</Description>
Example Code [XML]
The following example shows a description that provides a localizable display name for the system WebApplication.
<Description>
<Entry Name="Description"
Manager="WebAppManager"
ResourceId="WebApplication.Description"
>Describes the configuration, files, and directories of a web
application as a system. Data can be exposed or consumed
through endpoints.
</Entry>
<Entry Name="DisplayName"
Manager="WebAppManager"
ResourceId="WebApplication.DisplayName"
>ASP.NETWebApplication
</Entry>
</Description>
See Also
SystemDefinitionModel Schema Complex Types
Send comments about this topic to Microsoft
Build date: 9/5/2007