Represents the string search field. More...

Inherits Aspose::Email::Tools::Search::ComparisonField.

Public Member Functions
	StringComparisonField (System::String fieldName, System::SharedPtr< MailQueryBuilder > owner)
	Initializes a new instance of the StringComparisonField class. More...

System::SharedPtr< MailQuery >	Contains (System::String value)
	Indicates that field in message must contain the specified value. More...

System::SharedPtr< MailQuery >	Contains (System::String value, bool ignoreCase)
	Indicates that field in message must contain the specified value. More...

System::SharedPtr< MailQuery >	NotContains (System::String value)
	Indicates that field in message must not contain the specified value. More...

System::SharedPtr< MailQuery >	NotContains (System::String value, bool ignoreCase)
	Indicates that field in message must not contain the specified value. More...

System::SharedPtr< MailQuery >	Equals (System::String value)
	Indicates that field in message must be equal to the specified value. More...

System::SharedPtr< MailQuery >	Equals (System::String value, bool ignoreCase)
	Indicates that field in message must be equal to the specified value. More...

System::SharedPtr< MailQuery >	NotEquals (System::String value)
	Indicates that field in message must not be equal to the specified value. More...

System::SharedPtr< MailQuery >	NotEquals (System::String value, bool ignoreCase)
	Indicates that field in message must not be equal to the specified value. More...

System::SharedPtr< MailQuery >	Empty ()
	Indicates that field in message must be empty. More...

System::SharedPtr< MailQuery >	NotEmpty ()
	Indicates that field in message must not be empty. More...

Public Member Functions inherited from Aspose::Email::Tools::Search::ComparisonField
void	OrderBy (bool ascending)
	Sets value which indicates if client uses ascending or descending sorting on the Field. More...

System::SharedPtr< MailQuery >	Exists (bool value)

Protected Member Functions
System::SharedPtr< MailQuery >	CreateKey (System::String name, System::String value, System::String comparsionOperator) override
	Creates the search key. More...

Protected Member Functions inherited from Aspose::Email::Tools::Search::ComparisonField
	ComparisonField (System::String fieldName, System::SharedPtr< MailQueryBuilder > owner)
	Initializes a new instance of the ComparisonField class. More...

System::SharedPtr< MailQuery >	CreateKey (System::String name, System::SharedPtr< System::BoxedValueBase > value, System::String comparsionOperator)
	Creates the search key. More...

Protected Member Functions inherited from Aspose::Email::Tools::Search::QueryField
	QueryField (System::String fieldName, System::SharedPtr< MailQueryBuilder > owner)
	Initializes a new instance of the ComparisonField class. More...

Friends
class	Aspose::Email::Clients::Exchange::ExtendedPropertiesComparisonField

class	Aspose::Email::Clients::Exchange::AppointmentQueryBuilder

class	Aspose::Email::Clients::Exchange::ContactQueryBuilder

class	Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder

class	Aspose::Email::Tools::Search::MailQueryBuilder

class	Aspose::Email::Clients::Exchange::ExchangeQueryBuilder

class	Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder

Additional Inherited Members
Protected Attributes inherited from Aspose::Email::Tools::Search::QueryField
System::String	FieldName
	Field Name. More...

System::SharedPtr< MailQueryBuilder >	owner
	Owner of this object. More...

Detailed Description

Represents the string search field.

Constructor & Destructor Documentation

◆ StringComparisonField()

Aspose::Email::Tools::Search::StringComparisonField::StringComparisonField	(	System::String	fieldName,
		System::SharedPtr< MailQueryBuilder >	owner
	)

Initializes a new instance of the StringComparisonField class.

Parameters

fieldName	Name of the field.
owner	Owner of ComparisonField field object.

Member Function Documentation

◆ Contains() [1/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::Contains ( System::String value )

Indicates that field in message must contain the specified value.

Parameters

value The value.

Returns: MailQuery that represents search query (one searching criterion).

◆ Contains() [2/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::Contains	(	System::String	value,
		bool	ignoreCase
	)

Indicates that field in message must contain the specified value.

Parameters

value	The value.
ignoreCase	true to ignore case during the comparison; otherwise, false.

Returns: MailQuery that represents search query (one searching criterion).

Exceptions

AsposeArgumentNullException value;Field value should not be null or empty

◆ CreateKey()

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::CreateKey	(	System::String	name,
		System::String	value,
		System::String	comparsionOperator
	)

overrideprotectedvirtual

Creates the search key.

Parameters

name	The field name.
value	The value.
comparsionOperator	The operator.

Returns: MailQuery that represents search query.

Reimplemented from Aspose::Email::Tools::Search::ComparisonField.

◆ Empty()

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::Empty ( )

Indicates that field in message must be empty.

Returns: MailQuery that represents search query (one searching criterion).

◆ Equals() [1/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::Equals ( System::String value )

Indicates that field in message must be equal to the specified value.

Parameters

value The value.

Returns: MailQuery that represents search query (one searching criterion).

◆ Equals() [2/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::Equals	(	System::String	value,
		bool	ignoreCase
	)

Indicates that field in message must be equal to the specified value.

Parameters

value	The value.
ignoreCase	true to ignore case during the comparison; otherwise, false.

Returns: MailQuery that represents search query (one searching criterion).

◆ NotContains() [1/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::NotContains ( System::String value )

Indicates that field in message must not contain the specified value.

Parameters

value The value.

Returns: MailQuery that represents search query (one searching criterion).

◆ NotContains() [2/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::NotContains	(	System::String	value,
		bool	ignoreCase
	)

Indicates that field in message must not contain the specified value.

Parameters

value	The value.
ignoreCase	true to ignore case during the comparison; otherwise, false.

Returns: MailQuery that represents search query (one searching criterion).

◆ NotEmpty()

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::NotEmpty ( )

Indicates that field in message must not be empty.

Returns: MailQuery that represents search query (one searching criterion).

◆ NotEquals() [1/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::NotEquals ( System::String value )

Indicates that field in message must not be equal to the specified value.

Parameters

value The value.

Returns: MailQuery that represents search query (one searching criterion).

◆ NotEquals() [2/2]

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::StringComparisonField::NotEquals	(	System::String	value,
		bool	ignoreCase
	)

Indicates that field in message must not be equal to the specified value.

Parameters

value	The value.
ignoreCase	true to ignore case during the comparison; otherwise, false.

Returns: MailQuery that represents search query (one searching criterion).

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::AppointmentQueryBuilder

friend class Aspose::Email::Clients::Exchange::AppointmentQueryBuilder

friend

◆ Aspose::Email::Clients::Exchange::ContactQueryBuilder

friend class Aspose::Email::Clients::Exchange::ContactQueryBuilder

friend

◆ Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder

friend class Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder

friend

◆ Aspose::Email::Clients::Exchange::ExchangeQueryBuilder

friend class Aspose::Email::Clients::Exchange::ExchangeQueryBuilder

friend

◆ Aspose::Email::Clients::Exchange::ExtendedPropertiesComparisonField

friend class Aspose::Email::Clients::Exchange::ExtendedPropertiesComparisonField

friend

◆ Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder

friend class Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder

friend

◆ Aspose::Email::Tools::Search::MailQueryBuilder

friend class Aspose::Email::Tools::Search::MailQueryBuilder

friend

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringComparisonField()

Member Function Documentation

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ CreateKey()

◆ Empty()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ NotContains() [1/2]

◆ NotContains() [2/2]

◆ NotEmpty()

◆ NotEquals() [1/2]

◆ NotEquals() [2/2]

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::AppointmentQueryBuilder

◆ Aspose::Email::Clients::Exchange::ContactQueryBuilder

◆ Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder

◆ Aspose::Email::Clients::Exchange::ExchangeQueryBuilder

◆ Aspose::Email::Clients::Exchange::ExtendedPropertiesComparisonField

◆ Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder

◆ Aspose::Email::Tools::Search::MailQueryBuilder