Classe AddSolutionComponentRequest

Article
12/01/2014

S'applique à: CRM 2015 on-prem, CRM Online

Contains the data that is needed to add a solution component to an unmanaged solution.

Espace de noms: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (dans Microsoft.Crm.Sdk.Proxy.dll)

Syntaxe

'Déclaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class AddSolutionComponentRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class AddSolutionComponentRequest : OrganizationRequest

Exemple

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

The following code example adds the account entity to a solution that is specified in the SolutionUniqueName property.

// Add an existing Solution Component
//Add the Account entity to the solution
RetrieveEntityRequest retrieveForAddAccountRequest = new RetrieveEntityRequest()
{
    LogicalName = Account.EntityLogicalName
};
RetrieveEntityResponse retrieveForAddAccountResponse = (RetrieveEntityResponse)_serviceProxy.Execute(retrieveForAddAccountRequest);
AddSolutionComponentRequest addReq = new AddSolutionComponentRequest()
{
    ComponentType = (int)componenttype.Entity,
    ComponentId = (Guid)retrieveForAddAccountResponse.EntityMetadata.MetadataId,
    SolutionUniqueName = solution.UniqueName
};
_serviceProxy.Execute(addReq);

Remarques

Message Availability

Pour que ce message fonctionne, l'appelant doit être connecté au serveur.

Usage

Pass an instance of this class to the Execute method, which returns an instance of AddSolutionComponentResponse class.

Privileges and Access Rights

To perform this action, the caller must have the privileges that are listed in AddSolutionComponent Privileges.

Notes for Callers

The componenttype enumeration defines the supported range of values for this property. You can access the available values by including the SampleCode\CS\HelperCode\OptionSets.cs file or the SampleCode\VB\HelperCode\OptionSets.vb file in your project.

An alternative to using this message is to create or update the solution component for a specific solution. When you use this technique, you add the solution component to both the default solution and the specified solution. You can implement the specific-solution technique in two ways.

Use the SolutionUniqueName parameter on the solution component create and update requests.
Pass the SolutionUniqueName optional parameter to the CreateRequest or UpdateRequest.

Use the SolutionUniqueName parameter on the solution component create and update requests.

For solution components that have a create or update request message that includes the SolutionUniqueName property, passing the unique name of the solution adds the solution component to that solution. The following messages include a SolutionUniqueName property:

Pass the SolutionUniqueName optional parameter to the CreateRequest or UpdateRequest.

For other solution components, add “SolutionUniqueName” as a parameter to the Parameters property when you use the CreateRequest or UpdateRequest messages. For more information, see Pass Optional Parameters in Messages.

Supported Entities

This message can only be used for valid solution components.

Adding Application Ribbons to a Solution.

When you use AddSolutionComponentRequest to add application ribbons to your solution, you must make sure to include the RibbonCustomization solution component that is associated with the active solution. Use the Active Solution.SolutionId in the query expression you use to retrieve the RibbonCustomization record.

QueryExpression query = new QueryExpression("ribboncustomization");
query.ColumnSet = new ColumnSet("ribboncustomizationid");
query.Criteria = new FilterExpression();
query.Criteria.AddCondition("entity", ConditionOperator.Null);
query.Criteria.AddCondition("solutionid", ConditionOperator.Equal, new Guid("{FD140AAE-4DF4-11DD-BD17-0019B9312238}"));
RetrieveMultipleRequest req = new RetrieveMultipleRequest();
req.Query = query;
RetrieveMultipleResponse resp = (RetrieveMultipleResponse)_context.Execute(req);
RibbonCustomization activeRibbonCustomization = (RibbonCustomization)resp.EntityCollection[0];

Hiérarchie d'héritage

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.AddSolutionComponentRequest

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres AddSolutionComponentRequest
Espace de noms Microsoft.Crm.Sdk.Messages
AddSolutionComponentResponse
Constant SolutionId Values

Autres ressources

AddSolutionComponent Privileges
Sample: Work With Solutions
Work with Solutions
SolutionComponent Entity Messages and Methods
Dependency Tracking for Solution Components

Partager via