MetadataConditionExpression Class

 

Applies To: Dynamics CRM 2015

Contains a condition expression used to filter the results of the metadata query.

Namespace:   Microsoft.Xrm.Sdk.Metadata.Query
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.Metadata.Query.MetadataConditionExpression

Syntax

[DataContractAttribute(Name = "MetadataConditionExpression", 
    Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")]
[KnownTypeAttribute("GetKnownConditionValueTypes")]
public sealed class MetadataConditionExpression : IExtensibleDataObject
[DataContractAttribute(Name = "MetadataConditionExpression", 
    Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")]
[KnownTypeAttribute("GetKnownConditionValueTypes")]
public ref class MetadataConditionExpression sealed : IExtensibleDataObject
[<Sealed>]
[<DataContractAttribute(Name = "MetadataConditionExpression",
    Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")>]
[<KnownTypeAttribute("GetKnownConditionValueTypes")>]
type MetadataConditionExpression = 
    class
        interface IExtensibleDataObject
    end
<DataContractAttribute(Name := "MetadataConditionExpression",
    Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata/Query")>
<KnownTypeAttribute("GetKnownConditionValueTypes")>
Public NotInheritable Class MetadataConditionExpression
    Implements IExtensibleDataObject

Constructors

Name Description
System_CAPS_pubmethod MetadataConditionExpression()

Initializes a new instance of the MetadataConditionExpression class.

System_CAPS_pubmethod MetadataConditionExpression(String, MetadataConditionOperator, Object)

Initializes a new instance of the MetadataConditionExpression class.

Properties

Name Description
System_CAPS_pubproperty ConditionOperator

Gets or sets the condition operator.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data.

System_CAPS_pubproperty PropertyName

Gets or sets the name of the metadata property in the condition expression.

System_CAPS_pubproperty Value

Gets or sets the value for the metadata property.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

The following code snippet from Sample: Query metadata and detect changes shows the use of MetadataConditionExpression to set conditions for Entities and Attributes to return.



     // An array SchemaName values for non-intersect, user-owned entities that should not be returned.
     String[] excludedEntities = {
"WorkflowLog",
"Template",
"CustomerOpportunityRole",
"Import",
"UserQueryVisualization",
"UserEntityInstanceData",
"ImportLog",
"RecurrenceRule",
"QuoteClose",
"UserForm",
"SharePointDocumentLocation",
"Queue",
"DuplicateRule",
"OpportunityClose",
"Workflow",
"RecurringAppointmentMaster",
"CustomerRelationship",
"Annotation",
"SharePointSite",
"ImportData",
"ImportFile",
"OrderClose",
"Contract",
"BulkOperation",
"CampaignResponse",
"Connection",
"Report",
"CampaignActivity",
"UserEntityUISettings",
"IncidentResolution",
"GoalRollupQuery",
"MailMergeTemplate",
"Campaign",
"PostFollow",
"ImportMap",
"Goal",
"AsyncOperation",
"ProcessSession",
"UserQuery",
"ActivityPointer",
"List",
"ServiceAppointment"};

     //A filter expression to limit entities returned to non-intersect, user-owned entities not found in the list of excluded entities.
     MetadataFilterExpression EntityFilter = new MetadataFilterExpression(LogicalOperator.And);
     EntityFilter.Conditions.Add(new MetadataConditionExpression("IsIntersect", MetadataConditionOperator.Equals, false));
     EntityFilter.Conditions.Add(new MetadataConditionExpression("OwnershipType", MetadataConditionOperator.Equals, OwnershipTypes.UserOwned));
     EntityFilter.Conditions.Add(new MetadataConditionExpression("SchemaName", MetadataConditionOperator.NotIn, excludedEntities));
     MetadataConditionExpression isVisibileInMobileTrue = new MetadataConditionExpression("IsVisibleInMobile", MetadataConditionOperator.Equals, true);
     EntityFilter.Conditions.Add(isVisibileInMobileTrue);

//A condition expresson to return optionset attributes
MetadataConditionExpression[] optionsetAttributeTypes = new MetadataConditionExpression[] { 
new MetadataConditionExpression("AttributeType", MetadataConditionOperator.Equals, AttributeTypeCode.Picklist),
new MetadataConditionExpression("AttributeType", MetadataConditionOperator.Equals, AttributeTypeCode.State),
new MetadataConditionExpression("AttributeType", MetadataConditionOperator.Equals, AttributeTypeCode.Status),
new MetadataConditionExpression("AttributeType", MetadataConditionOperator.Equals, AttributeTypeCode.Boolean)
};

//A filter expression to apply the optionsetAttributeTypes condition expression
MetadataFilterExpression AttributeFilter = new MetadataFilterExpression(LogicalOperator.Or);
AttributeFilter.Conditions.AddRange(optionsetAttributeTypes);

//A Properties expression to limit the properties to be included with attributes
MetadataPropertiesExpression AttributeProperties = new MetadataPropertiesExpression() { AllProperties = false };
AttributeProperties.PropertyNames.Add("OptionSet");
AttributeProperties.PropertyNames.Add("AttributeType");

//An entity query expression to combine the filter expressions and property expressions for the query.
EntityQueryExpression entityQueryExpression = new EntityQueryExpression()
{

 Criteria = EntityFilter,
 Properties = EntityProperties,
 AttributeQuery = new AttributeQueryExpression()
 {
  Criteria = AttributeFilter,
  Properties = AttributeProperties
 },
 LabelQuery = labelQuery

};

//Retrieve the metadata for the query without a ClientVersionStamp
RetrieveMetadataChangesResponse initialRequest = getMetadataChanges(entityQueryExpression, null, DeletedMetadataFilters.OptionSet);

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Xrm.Sdk.Metadata.Query Namespace
Retrieve and detect changes to metadata
Sample: Query metadata and detect changes

Return to top

© 2016 Microsoft. All rights reserved. Copyright