AddSolutionComponentRequest AddSolutionComponentRequest AddSolutionComponentRequest AddSolutionComponentRequest Class

Definition

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

For the Web API use the AddSolutionComponent Action.

public ref class AddSolutionComponentRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddSolutionComponentRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type AddSolutionComponentRequest = class
    inherit OrganizationRequest
Public NotInheritable Class AddSolutionComponentRequest
Inherits OrganizationRequest
Inheritance
AddSolutionComponentRequestAddSolutionComponentRequestAddSolutionComponentRequestAddSolutionComponentRequest
Attributes

Examples

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

var retrieveForAddAccountRequest = new RetrieveEntityRequest() { LogicalName = Account.EntityLogicalName };

var retrieveForAddAccountResponse = (RetrieveEntityResponse)svc.Execute(retrieveForAddAccountRequest); var addReq = new AddSolutionComponentRequest() { ComponentType = (int)componenttype.Entity, ComponentId = (Guid)retrieveForAddAccountResponse.EntityMetadata.MetadataId, SolutionUniqueName = solution.UniqueName }; svc.Execute(addReq);

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.

Solutions#WorkWithSolutions5 SolutionsVB#WorkWithSolutions5

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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 message 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 218d9d80-fb52-49a4-9208-b72675080451#bkmk_optional_params.

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];

Constructors

AddSolutionComponentRequest() AddSolutionComponentRequest() AddSolutionComponentRequest() AddSolutionComponentRequest()

Initializes a new instance of the AddSolutionComponentRequest class.

Properties

AddRequiredComponents AddRequiredComponents AddRequiredComponents AddRequiredComponents

Gets or sets a value that indicates whether other solution components that are required by the solution component that you are adding should also be added to the unmanaged solution. Required.

ComponentId ComponentId ComponentId ComponentId

Gets or sets the ID of the solution component. Required.

ComponentType ComponentType ComponentType ComponentType

Gets or sets the value that represents the solution component that you are adding. Required.

DoNotIncludeSubcomponents DoNotIncludeSubcomponents DoNotIncludeSubcomponents DoNotIncludeSubcomponents

Indicates whether the subcomponents should be included.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
IncludedComponentSettingsValues IncludedComponentSettingsValues IncludedComponentSettingsValues IncludedComponentSettingsValues

Gets or sets a value that specifies if the component is added to the solution with its metadata.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SolutionUniqueName SolutionUniqueName SolutionUniqueName SolutionUniqueName

Gets or sets the unique name of the solution you are adding the solution component to. Required.

Applies to

See also