Personnaliser les groupes d’options généraux
Date de publication : janvier 2017
S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Généralement, vous utilisez les groupes d’options généraux pour définir des champs afin que des champs différents puissent partager le même groupe d’options, qui sont conservées dans un seul emplacement. Vous pouvez réutiliser les groupes d’options généraux. Vous les verrez également utilisées dans les paramètres de demande de façon similaire à une énumération.
Lorsque vous définissez une valeur d’option à l’aide de OptionMetadata, nous vous recommandons de laisser le système attribuer une valeur. Pour ce faire, transmettez une valeur null lorsque vous créez l'instance OptionMetadata. Lorsque vous définissez une option, elle contiendra un préfixe de valeur d’option spécifique au contexte du groupe d’éditeurs pour la solution dans laquelle le groupe d’options est créé. Ce préfixe aide à réduire l’opportunité de créer des groupes d’options doubles pour une solution gérée, et dans tous les groupes d’options qui sont définis dans les organisations où votre solution gérée est installée. Pour plus d'informations, voir Fusionner les options d’un groupe d’options.
Contenu de la rubrique
Récupérer un groupe d’options général
Créer un groupe d’options général
Créer une liste déroulante qui utilise un groupe d’options général
Mettre à jour un groupe d’options général
Récupérer tous les groupes d’options généraux
Supprimer un groupe d’options général
Récupérer un groupe d’options général
L’exemple suivant montre comment récupérer un groupe d’options général par nom à l’aide du message RetrieveOptionSetRequest :
// Use the RetrieveOptionSetRequest message to retrieve
// a global option set by it's name.
RetrieveOptionSetRequest retrieveOptionSetRequest =
new RetrieveOptionSetRequest
{
Name = _globalOptionSetName
};
// Execute the request.
RetrieveOptionSetResponse retrieveOptionSetResponse =
(RetrieveOptionSetResponse)_serviceProxy.Execute(
retrieveOptionSetRequest);
Console.WriteLine("Retrieved {0}.",
retrieveOptionSetRequest.Name);
// Access the retrieved OptionSetMetadata.
OptionSetMetadata retrievedOptionSetMetadata =
(OptionSetMetadata)retrieveOptionSetResponse.OptionSetMetadata;
// Get the current options list for the retrieved attribute.
OptionMetadata[] optionList =
retrievedOptionSetMetadata.Options.ToArray();
' Use the RetrieveOptionSetRequest message to retrieve
' a global option set by it's name.
Dim retrieveOptionSetRequest As RetrieveOptionSetRequest = New RetrieveOptionSetRequest With {
.Name = _globalOptionSetName
}
' Execute the request.
Dim retrieveOptionSetResponse As RetrieveOptionSetResponse =
CType(_serviceProxy.Execute(retrieveOptionSetRequest), RetrieveOptionSetResponse)
Console.WriteLine("Retrieved {0}.", retrieveOptionSetRequest.Name)
' Access the retrieved OptionSetMetadata.
Dim retrievedOptionSetMetadata As OptionSetMetadata =
CType(retrieveOptionSetResponse.OptionSetMetadata, OptionSetMetadata)
' Get the current options list for the retrieved attribute.
Dim optionList() As OptionMetadata = retrievedOptionSetMetadata.Options.ToArray()
Créer un groupe d’options général
Utilisez le message CreateOptionSetRequest pour créer un groupe d’options général. Définissez la propriété IsGlobal sur true pour indiquer que le groupe d’options est général. L’exemple de code suivant crée un groupe d’options général appelé « Exemple de groupe d’options » :
#region How to create global option set
// Define the request object and pass to the service.
CreateOptionSetRequest createOptionSetRequest = new CreateOptionSetRequest
{
// Create a global option set (OptionSetMetadata).
OptionSet = new OptionSetMetadata
{
Name = _globalOptionSetName,
DisplayName = new Label("Example Option Set", _languageCode),
IsGlobal = true,
OptionSetType = OptionSetType.Picklist,
Options =
{
new OptionMetadata(new Label("Open", _languageCode), null),
new OptionMetadata(new Label("Suspended", _languageCode), null),
new OptionMetadata(new Label("Cancelled", _languageCode), null),
new OptionMetadata(new Label("Closed", _languageCode), null)
}
}
};
// Execute the request.
CreateOptionSetResponse optionsResp =
(CreateOptionSetResponse)_serviceProxy.Execute(createOptionSetRequest);
' #Region "How to create global option set"
' Define the request object and pass to the service.
Dim createOptionSetRequest As CreateOptionSetRequest = New CreateOptionSetRequest()
Dim createOptionSetOptionSet As OptionSetMetadata = New OptionSetMetadata() With {
.Name = _globalOptionSetName,
.DisplayName = New Label("Example Option Set", _languageCode),
.IsGlobal = True,
.OptionSetType = OptionSetType.Picklist
}
createOptionSetOptionSet.Options.AddRange(
{
New OptionMetadata(New Label("Open", _languageCode), Nothing),
New OptionMetadata(New Label("Suspended", _languageCode), Nothing),
New OptionMetadata(New Label("Cancelled", _languageCode), Nothing),
New OptionMetadata(New Label("Closed", _languageCode), Nothing)
}
)
createOptionSetRequest.OptionSet = createOptionSetOptionSet
' Create a global option set (OptionSetMetadata).
' Execute the request.
Dim optionsResp As CreateOptionSetResponse =
CType(_serviceProxy.Execute(createOptionSetRequest), CreateOptionSetResponse)
Créer une liste déroulante qui utilise un groupe d’options général
Cet exemple explique comment créer un attribut de liste déroulante qui utilise un groupe d’options général en utilisant CreateAttributeRequest :
// Create a Picklist linked to the option set.
// Specify which entity will own the picklist, and create it.
CreateAttributeRequest createRequest = new CreateAttributeRequest
{
EntityName = Contact.EntityLogicalName,
Attribute = new PicklistAttributeMetadata
{
SchemaName = "sample_examplepicklist",
LogicalName = "sample_examplepicklist",
DisplayName = new Label("Example Picklist", _languageCode),
RequiredLevel = new AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.None),
// In order to relate the picklist to the global option set, be sure
// to specify the two attributes below appropriately.
// Failing to do so will lead to errors.
OptionSet = new OptionSetMetadata
{
IsGlobal = true,
Name = _globalOptionSetName
}
}
};
_serviceProxy.Execute(createRequest);
' Create a Picklist linked to the option set.
' Specify which entity will own the picklist, and create it.
Dim createRequest As CreateAttributeRequest = New CreateAttributeRequest With {
.EntityName = Contact.EntityLogicalName,
.Attribute = New PicklistAttributeMetadata With {
.SchemaName = "sample_examplepicklist", .LogicalName = "sample_examplepicklist",
.DisplayName = New Label("Example Picklist", _languageCode),
.RequiredLevel = New AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.None),
.OptionSet = New OptionSetMetadata With {
.IsGlobal = True,
.Name = _globalOptionSetName
}
}
}
' In order to relate the picklist to the global option set, be sure
' to specify the two attributes below appropriately.
' Failing to do so will lead to errors.
_serviceProxy.Execute(createRequest)
Mettre à jour un groupe d’options général
L’exemple suivant montre comment mettre à jour le nom pour un groupe d’options général en utilisant UpdateOptionSetRequest :
// Use UpdateOptionSetRequest to update the basic information of an option
// set. Updating option set values requires different messages (see below).
UpdateOptionSetRequest updateOptionSetRequest = new UpdateOptionSetRequest
{
OptionSet = new OptionSetMetadata
{
DisplayName = new Label("Updated Option Set", _languageCode),
Name = _globalOptionSetName,
IsGlobal = true
}
};
_serviceProxy.Execute(updateOptionSetRequest);
//Publish the OptionSet
PublishXmlRequest pxReq1 = new PublishXmlRequest { ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>", _globalOptionSetName) };
_serviceProxy.Execute(pxReq1);
' Use UpdateOptionSetRequest to update the basic information of an option
' set. Updating option set values requires different messages (see below).
Dim updateOptionSetRequest As UpdateOptionSetRequest = New UpdateOptionSetRequest With {
.OptionSet = New OptionSetMetadata With {
.DisplayName = New Label("Updated Option Set", _languageCode),
.Name = _globalOptionSetName,
.IsGlobal = True
}
}
_serviceProxy.Execute(updateOptionSetRequest)
'Publish the OptionSet
Dim pxReq1 As PublishXmlRequest = New PublishXmlRequest With {
.ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>", _globalOptionSetName)
}
_serviceProxy.Execute(pxReq1)
Ordre des options
L’exemple suivant montre comment les options d’un groupe d’options général peuvent être triées à l’aide de OrderOptionRequest :
// Change the order of the original option's list.
// Use the OrderBy (OrderByDescending) linq function to sort options in
// ascending (descending) order according to label text.
// For ascending order use this:
var updateOptionList =
optionList.OrderBy(x => x.Label.LocalizedLabels[0].Label).ToList();
// For descending order use this:
// var updateOptionList =
// optionList.OrderByDescending(
// x => x.Label.LocalizedLabels[0].Label).ToList();
// Create the request.
OrderOptionRequest orderOptionRequest = new OrderOptionRequest
{
// Set the properties for the request.
OptionSetName = _globalOptionSetName,
// Set the changed order using Select linq function
// to get only values in an array from the changed option list.
Values = updateOptionList.Select(x => x.Value.Value).ToArray()
};
// Execute the request
_serviceProxy.Execute(orderOptionRequest);
//Publish the OptionSet
PublishXmlRequest pxReq4 = new PublishXmlRequest { ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>", _globalOptionSetName) };
_serviceProxy.Execute(pxReq4);
' Change the order of the original option's list.
' Use the OrderBy (OrderByDescending) linq function to sort options in
' ascending (descending) order according to label text.
' For ascending order use this:
Dim updateOptionList = optionList.OrderBy(Function(x) x.Label.LocalizedLabels(0).Label).ToList()
' For descending order use this:
' var updateOptionList =
' optionList.OrderByDescending(
' x => x.Label.LocalizedLabels[0].Label).ToList();
' Create the request.
Dim orderOptionRequest As OrderOptionRequest =
New OrderOptionRequest With {
.OptionSetName = _globalOptionSetName,
.Values = updateOptionList.Select(Function(x) x.Value.Value).ToArray()
}
' Set the properties for the request.
' Set the changed order using Select linq function
' to get only values in an array from the changed option list.
' Execute the request
_serviceProxy.Execute(orderOptionRequest)
'Publish the OptionSet
Dim pxReq4 As PublishXmlRequest =
New PublishXmlRequest With {
.ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>",
_globalOptionSetName)
}
_serviceProxy.Execute(pxReq4)
Récupérer tous les groupes d’options généraux
L’exemple suivant montre comment récupérer tous les groupe d’options généraux à l’aide de RetrieveAllOptionSetsRequest :
// Use RetrieveAllOptionSetsRequest to retrieve all global option sets.
// Create the request.
RetrieveAllOptionSetsRequest retrieveAllOptionSetsRequest =
new RetrieveAllOptionSetsRequest();
// Execute the request
RetrieveAllOptionSetsResponse retrieveAllOptionSetsResponse =
(RetrieveAllOptionSetsResponse)_serviceProxy.Execute(
retrieveAllOptionSetsRequest);
// Now you can use RetrieveAllOptionSetsResponse.OptionSetMetadata property to
// work with all retrieved option sets.
if (retrieveAllOptionSetsResponse.OptionSetMetadata.Count() > 0)
{
Console.WriteLine("All the global option sets retrieved as below:");
int count = 1;
foreach (OptionSetMetadataBase optionSetMetadata in
retrieveAllOptionSetsResponse.OptionSetMetadata)
{
Console.WriteLine("{0} {1}", count++,
(optionSetMetadata.DisplayName.LocalizedLabels.Count >0)? optionSetMetadata.DisplayName.LocalizedLabels[0].Label : String.Empty);
}
}
' Use RetrieveAllOptionSetsRequest to retrieve all global option sets.
' Create the request.
Dim retrieveAllOptionSetsRequest As New RetrieveAllOptionSetsRequest()
' Execute the request
Dim retrieveAllOptionSetsResponse As RetrieveAllOptionSetsResponse =
CType(_serviceProxy.Execute(retrieveAllOptionSetsRequest), RetrieveAllOptionSetsResponse)
' Now you can use RetrieveAllOptionSetsResponse.OptionSetMetadata property to
' work with all retrieved option sets.
If retrieveAllOptionSetsResponse.OptionSetMetadata.Count() > 0 Then
Console.WriteLine("All the global option sets retrieved as below:")
Dim count As Integer = 1
For Each optionSetMetadata As OptionSetMetadataBase In retrieveAllOptionSetsResponse.OptionSetMetadata
Console.WriteLine("{0} {1}",
count,
If(optionSetMetadata.DisplayName.LocalizedLabels.Count > 0,
optionSetMetadata.DisplayName.LocalizedLabels(0).Label,
String.Empty))
count += 1
Next optionSetMetadata
End If
Supprimer un groupe d’options général
L’exemple suivant indique comment vérifier si un groupe d’options général est utilisé par un autre composant de solution en utilisant RetrieveDependentComponentsRequest, puis comment le supprimer en utilisant DeleteOptionSetRequest :
// Create the request to see which components have a dependency on the
// global option set.
RetrieveDependentComponentsRequest dependencyRequest =
new RetrieveDependentComponentsRequest
{
ObjectId = _optionSetId,
ComponentType = (int)componenttype.OptionSet
};
RetrieveDependentComponentsResponse dependencyResponse =
(RetrieveDependentComponentsResponse)_serviceProxy.Execute(
dependencyRequest);
// Here you would check the dependencyResponse.EntityCollection property
// and act as appropriate. However, we know there is exactly one
// dependency so this example deals with it directly and deletes
// the previously created attribute.
DeleteAttributeRequest deleteAttributeRequest =
new DeleteAttributeRequest
{
EntityLogicalName = Contact.EntityLogicalName,
LogicalName = "sample_examplepicklist"
};
_serviceProxy.Execute(deleteAttributeRequest);
Console.WriteLine("Referring attribute deleted.");
#endregion How to delete attribute
#region How to delete global option set
// Finally, delete the global option set. Attempting this before deleting
// the picklist above will result in an exception being thrown.
DeleteOptionSetRequest deleteRequest = new DeleteOptionSetRequest
{
Name = _globalOptionSetName
};
_serviceProxy.Execute(deleteRequest);
' Create the request to see which components have a dependency on the
' global option set.
Dim dependencyRequest As RetrieveDependentComponentsRequest =
New RetrieveDependentComponentsRequest With {
.ObjectId = _optionSetId,
.ComponentType = componenttype.OptionSet
}
Dim dependencyResponse As RetrieveDependentComponentsResponse =
CType(_serviceProxy.Execute(dependencyRequest), RetrieveDependentComponentsResponse)
' Here you would check the dependencyResponse.EntityCollection property
' and act as appropriate. However, we know there is exactly one
' dependency so this example deals with it directly and deletes
' the previously created attribute.
Dim deleteAttributeRequest As DeleteAttributeRequest =
New DeleteAttributeRequest With {
.EntityLogicalName = Contact.EntityLogicalName,
.LogicalName = "sample_examplepicklist"
}
_serviceProxy.Execute(deleteAttributeRequest)
Console.WriteLine("Referring attribute deleted.")
'#End Region ' How to delete attribute
'#Region "How to delete global option set"
' Finally, delete the global option set. Attempting this before deleting
' the picklist above will result in an exception being thrown.
Dim deleteRequest As DeleteOptionSetRequest =
New DeleteOptionSetRequest With {
.Name = _globalOptionSetName
}
_serviceProxy.Execute(deleteRequest)
Voir aussi
Personnaliser les applications Microsoft Dynamics 365
Utiliser le service d'organisation avec des métadonnées Dynamics 365
Insérer, mettre à jour, supprimer et trier les option d’un groupe d’options global
Messages du groupe d’options général
Valeurs de métadonnées de groupe d’options général
Exemple : créer un groupe d’options général
Exemple : Utiliser des groupes d’options généraux
Exemple : vider les informations d’un groupe d’options général dans un fichier
Microsoft Dynamics 365
© 2017 Microsoft. Tous droits réservés. Copyright