Class PropertySet

Namespace

Microsoft.Exchange.WebServices.Data

Assembly

Microsoft.Exchange.WebServices.dll

Represents a set of item or folder properties. Property sets are used to indicate what properties of an item or folder should be loaded when binding to an existing item or folder or when loading an item or folder's properties.

public sealed class PropertySet : IEnumerable<PropertyDefinitionBase>, IEnumerable

Inheritance

object

PropertySet

Implements

IEnumerable<PropertyDefinitionBase>

IEnumerable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PropertySet()

Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly.

public PropertySet()

PropertySet(BasePropertySet)

Initializes a new instance of PropertySet.

public PropertySet(BasePropertySet basePropertySet)

Parameters

basePropertySet BasePropertySet

The base property set to base the property set upon.

PropertySet(BasePropertySet, params PropertyDefinitionBase[])

Initializes a new instance of PropertySet.

public PropertySet(BasePropertySet basePropertySet, params PropertyDefinitionBase[] additionalProperties)

Parameters

basePropertySet BasePropertySet

The base property set to base the property set upon.

additionalProperties PropertyDefinitionBase[]

Additional properties to include in the property set. Property definitions are available as static members from schema classes (for example, EmailMessageSchema.Subject, AppointmentSchema.Start, ContactSchema.GivenName, etc.)

PropertySet(BasePropertySet, IEnumerable<PropertyDefinitionBase>)

Initializes a new instance of PropertySet.

public PropertySet(BasePropertySet basePropertySet, IEnumerable<PropertyDefinitionBase> additionalProperties)

Parameters

basePropertySet BasePropertySet

The base property set to base the property set upon.

additionalProperties IEnumerable<PropertyDefinitionBase>

Additional properties to include in the property set. Property definitions are available as static members from schema classes (for example, EmailMessageSchema.Subject, AppointmentSchema.Start, ContactSchema.GivenName, etc.)

PropertySet(params PropertyDefinitionBase[])

Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly.

public PropertySet(params PropertyDefinitionBase[] additionalProperties)

Parameters

additionalProperties PropertyDefinitionBase[]

Additional properties to include in the property set. Property definitions are available as static members from schema classes (for example, EmailMessageSchema.Subject, AppointmentSchema.Start, ContactSchema.GivenName, etc.)

PropertySet(IEnumerable<PropertyDefinitionBase>)

Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly.

public PropertySet(IEnumerable<PropertyDefinitionBase> additionalProperties)

Parameters

additionalProperties IEnumerable<PropertyDefinitionBase>

Additional properties to include in the property set. Property definitions are available as static members from schema classes (for example, EmailMessageSchema.Subject, AppointmentSchema.Start, ContactSchema.GivenName, etc.)

Fields

FirstClassProperties

Returns a predefined property set that includes the first class properties of an item or folder.

public static readonly PropertySet FirstClassProperties

Field Value

PropertySet

IdOnly

Returns a predefined property set that only includes the Id property.

public static readonly PropertySet IdOnly

Field Value

PropertySet

Properties

AddBlankTargetToLinks

Gets or sets value indicating whether or not to add blank target attribute to anchor links.

public bool? AddBlankTargetToLinks { get; set; }

Property Value

bool?

BasePropertySet

Gets or sets the base property set the property set is based upon.

public BasePropertySet BasePropertySet { get; set; }

Property Value

BasePropertySet

BlockExternalImages

Gets or sets value indicating whether or not to convert inline images to data URLs.

public bool? BlockExternalImages { get; set; }

Property Value

bool?

ConvertHtmlCodePageToUTF8

Gets or sets value indicating whether or not to convert HTML code page to UTF8 encoding.

public bool? ConvertHtmlCodePageToUTF8 { get; set; }

Property Value

bool?

Count

Gets the number of explicitly added properties in this set.

public int Count { get; }

Property Value

int

FilterHtmlContent

Gets or sets value indicating whether or not to filter potentially unsafe HTML content from message bodies.

public bool? FilterHtmlContent { get; set; }

Property Value

bool?

InlineImageUrlTemplate

Gets or sets a value of the URL template to use for the src attribute of inline IMG elements.

public string InlineImageUrlTemplate { get; set; }

Property Value

string

this[int]

Gets the PropertyDefinitionBase at the specified index.

public PropertyDefinitionBase this[int index] { get; }

Parameters

index int

Index.

Property Value

PropertyDefinitionBase

MaximumBodySize

Gets or sets the maximum size of the body to be retrieved.

public int? MaximumBodySize { get; set; }

Property Value

int?

The maximum size of the body to be retrieved.

RequestedBodyType

Gets or sets type of body that should be loaded on items. If RequestedBodyType is null, body is returned as HTML if available, plain text otherwise.

public BodyType? RequestedBodyType { get; set; }

Property Value

BodyType?

RequestedNormalizedBodyType

Gets or sets type of normalized body that should be loaded on items. If null, the should return the same value as body type.

public BodyType? RequestedNormalizedBodyType { get; set; }

Property Value

BodyType?

RequestedUniqueBodyType

Gets or sets type of body that should be loaded on items. If null, the should return the same value as body type.

public BodyType? RequestedUniqueBodyType { get; set; }

Property Value

BodyType?

Methods

Add(PropertyDefinitionBase)

Adds the specified property to the property set.

public void Add(PropertyDefinitionBase property)

Parameters

property PropertyDefinitionBase

The property to add.

AddRange(IEnumerable<PropertyDefinitionBase>)

Adds the specified properties to the property set.

public void AddRange(IEnumerable<PropertyDefinitionBase> properties)

Parameters

properties IEnumerable<PropertyDefinitionBase>

The properties to add.

Clear()

Remove all explicitly added properties from the property set.

public void Clear()

Contains(PropertyDefinitionBase)

Determines whether the specified property has been explicitly added to this property set using the Add or AddRange methods.

public bool Contains(PropertyDefinitionBase property)

Parameters

property PropertyDefinitionBase

The property.

Returns

bool

true if this property set contains the specified propert]; otherwise, false.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<PropertyDefinitionBase> GetEnumerator()

Returns

IEnumerator<PropertyDefinitionBase>

A IEnumerator<T> that can be used to iterate through the collection.

Remove(PropertyDefinitionBase)

Removes the specified property from the set.

public bool Remove(PropertyDefinitionBase property)

Parameters

property PropertyDefinitionBase

The property to remove.

Returns

bool

true if the property was successfully removed, false otherwise.

Operators

implicit operator PropertySet(BasePropertySet)

Implements an implicit conversion between PropertySet and BasePropertySet.

public static implicit operator PropertySet(BasePropertySet basePropertySet)

Parameters

basePropertySet BasePropertySet

The BasePropertySet value to convert from.

Returns

PropertySet

A PropertySet instance based on the specified base property set.