MetadataFilterExpression Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

Specifies complex condition and logical filter expressions used for filtering the results of a 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.MetadataFilterExpression

Syntax

[DataContractAttribute(Name = "MetadataFilterExpression", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")]
public sealed class MetadataFilterExpression : IExtensibleDataObject

[DataContractAttribute(Name = "MetadataFilterExpression", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")]
public ref class MetadataFilterExpression sealed : IExtensibleDataObject

[<Sealed>]
[<DataContractAttribute(Name = "MetadataFilterExpression", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata/Query")>]
type MetadataFilterExpression = 
    class
        interface IExtensibleDataObject
    end

<DataContractAttribute(Name := "MetadataFilterExpression", Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata/Query")>
Public NotInheritable Class MetadataFilterExpression
    Implements IExtensibleDataObject

Constructors

	Name	Description
	MetadataFilterExpression()	Initializes a new instance of the MetadataFilterExpression class.
	MetadataFilterExpression(LogicalOperator)	Initializes a new instance of the MetadataFilterExpression class.

Properties

	Name	Description
	Conditions	Gets condition expressions that include metadata properties, condition operators and values.
	ExtensionData	Gets or sets the structure that contains extra data.
	FilterOperator	Gets or sets the logical AND/OR filter operator.
	Filters	Gets a collection of logical filter expressions that filter the results of the metadata query.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

The following example shows the use of a MetadataFilterExpression to return non-intersect, user-owned entities not found in a list of excluded entities.



     // 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);

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.

Share via