ContactQueryOptions
ContactQueryOptions
ContactQueryOptions
ContactQueryOptions
Class
Definition
Used to specify the query options when searching for contacts.
public : sealed class ContactQueryOptions : IContactQueryOptionspublic sealed class ContactQueryOptions : IContactQueryOptionsPublic NotInheritable Class ContactQueryOptions Implements IContactQueryOptions// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
ContactQueryOptions() ContactQueryOptions() ContactQueryOptions() ContactQueryOptions()
Initializes a new instance of the ContactQueryOptions class.
public : ContactQueryOptions()public ContactQueryOptions()Public Sub New()// You can use this method in JavaScript.
ContactQueryOptions(String) ContactQueryOptions(String) ContactQueryOptions(String) ContactQueryOptions(String)
Initializes a new instance of the ContactQueryOptions class.
public : ContactQueryOptions(PlatForm::String text)public ContactQueryOptions(String text)Public Sub New(text As String)// You can use this method in JavaScript.
- text
- PlatForm::String String String String
The text to match in the search operation.
- See Also
ContactQueryOptions(String, ContactQuerySearchFields) ContactQueryOptions(String, ContactQuerySearchFields) ContactQueryOptions(String, ContactQuerySearchFields) ContactQueryOptions(String, ContactQuerySearchFields)
Initializes a new instance of the ContactQueryOptions class.
public : ContactQueryOptions(PlatForm::String text, ContactQuerySearchFields fields)public ContactQueryOptions(String text, ContactQuerySearchFields fields)Public Sub New(text As String, fields As ContactQuerySearchFields)// You can use this method in JavaScript.
- text
- PlatForm::String String String String
The text to match in the search operation.
- fields
- ContactQuerySearchFields ContactQuerySearchFields ContactQuerySearchFields ContactQuerySearchFields
Specifies which contact fields to search for a match.
- See Also
Properties
AnnotationListIds AnnotationListIds AnnotationListIds AnnotationListIds
Gets a list to which you can add ContactAnnotationList.Id values for which to search.
public : IVector<string> AnnotationListIds { get; }public IList<string> AnnotationListIds { get; }Public ReadOnly Property AnnotationListIds As IList<string>// You can use this property in JavaScript.
- Value
- IVector<PlatForm::String> IList<string> IList<string> IList<string>
A list to which you can add ContactAnnotationList.Id values for which to search.
ContactListIds ContactListIds ContactListIds ContactListIds
Gets a list to which you can add ContactList.Id values for which to search.
public : IVector<string> ContactListIds { get; }public IList<string> ContactListIds { get; }Public ReadOnly Property ContactListIds As IList<string>// You can use this property in JavaScript.
- Value
- IVector<PlatForm::String> IList<string> IList<string> IList<string>
A list to which you can add ContactList.Id values for which to search.
DesiredFields DesiredFields DesiredFields DesiredFields
Gets or sets the desired fields a contact must have to match the query.
public : ContactQueryDesiredFields DesiredFields { get; set; }public ContactQueryDesiredFields DesiredFields { get; set; }Public ReadWrite Property DesiredFields As ContactQueryDesiredFields// You can use this property in JavaScript.
- Value
- ContactQueryDesiredFields ContactQueryDesiredFields ContactQueryDesiredFields ContactQueryDesiredFields
The desired fields a contact must have to match the query.
Remarks
You can specify multiple fields by using the OR operator to combine values from the ContactQueryDesiredFields enum. The query results will return contacts that contain one or more of the desired fields.
DesiredOperations DesiredOperations DesiredOperations DesiredOperations
Gets or sets the desired annotation operations a contact must have to match the query.
public : ContactAnnotationOperations DesiredOperations { get; set; }public ContactAnnotationOperations DesiredOperations { get; set; }Public ReadWrite Property DesiredOperations As ContactAnnotationOperations// You can use this property in JavaScript.
- Value
- ContactAnnotationOperations ContactAnnotationOperations ContactAnnotationOperations ContactAnnotationOperations
The desired annotation operations a contact must have to match the query.
Remarks
You can specify multiple operations by using the OR operator to combine values from the ContactAnnotationOperations enum. The query results will return contacts that contain one or more of the desired operations.
IncludeContactsFromHiddenLists IncludeContactsFromHiddenLists IncludeContactsFromHiddenLists IncludeContactsFromHiddenLists
Gets or sets a Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface.
public : PlatForm::Boolean IncludeContactsFromHiddenLists { get; set; }public bool IncludeContactsFromHiddenLists { get; set; }Public ReadWrite Property IncludeContactsFromHiddenLists As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
A Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface.
TextSearch TextSearch TextSearch TextSearch
Gets a ContactQueryTextSearch object that can be used for text searches.
public : ContactQueryTextSearch TextSearch { get; }public ContactQueryTextSearch TextSearch { get; }Public ReadOnly Property TextSearch As ContactQueryTextSearch// You can use this property in JavaScript.
A ContactQueryTextSearch object that can be used for text searches.