Autodesk Vault ProfessionalVault API

SetDescription Method

Autodesk.DataManagement.Client.Framework.Forms.SettingsShowRestrictionsSettings

Sets the description that is displayed on the main part of the dialog. If all the restrictions affect the same object, the singular description will be used. Otherwise the dialog falls back to the multiple description.

Syntax

public void SetDescription(
   System.string singular,
   System.string multiple
)
Public Sub SetDescription( _
   ByVal singular As System.String, _
   Optional ByVal multiple As System.String _
) 

Parameters

NameDescription
singularThis string is used if all the restrictions provided to the dialog affect the same object. If it contains the string.Format() specifier '{0}', the object's name will be swapped for it.
multipleOptional parameter that provides the description for when multiple restricted objects are displayed.

Remarks

If the singular string contains the '{0}' specifier and the restrictions all affect the same object, then the Restricted Object Name column will be hidden in the grid. If the singular string does not contain the specifier, or if the restrictions afect more then one object, then the Restriected Object Name column will be shown in the grid.

See Also