ContactSearchInputBox Class

Definition

Namespace:

Microsoft.Lync.Controls

Assembly:

Microsoft.Lync.Controls.dll

Use the ContactSearchInputBox control to enable users to search their organization for people based on name, phone number, or skill.

public ref class ContactSearchInputBox : Microsoft::Lync::Controls::UCBase

[System.Windows.TemplatePart(Name="PART_SearchHint", Type=typeof(System.Windows.Controls.ContentControl))]
[System.Windows.TemplatePart(Name="PART_ClearButton", Type=typeof(System.Windows.Controls.Button))]
[System.Windows.TemplatePart(Name="PART_TextSearch", Type=typeof(System.Windows.Controls.TextBox))]
[System.Windows.TemplateVisualState(GroupName="SearchInUseStates", Name="SearchNotInUse")]
[System.Windows.TemplateVisualState(GroupName="SearchInUseStates", Name="SearchInUse")]
public class ContactSearchInputBox : Microsoft.Lync.Controls.UCBase

type ContactSearchInputBox = class
    inherit UCBase

Public Class ContactSearchInputBox
Inherits UCBase

Inheritance

Control

UCBase

ContactSearchInputBox

Attributes

TemplatePartAttribute TemplateVisualStateAttribute

Remarks

The ContactSearchInputBox control displays a text box where users enter a search string. The search is executed automatically, one second after the search text is changed, or explicitly when the user presses Enter in the ContactSearchInputBox. Once a search is complete, the results appear in a ContactSearchResultList control. The ContactSearchResultList control provides an input box for searching for contacts by name or keyword. The ContactSearchInputBox and ContactSearchResultList controls, while related, are designed as separate controls to allow the developer to display search results and search input in separate locations on a page. Use the ContactSearch control in Lync Control applications to display the ContactSearchInputBox and ContactSearchResultList controls together in the same location on a page.

Constructors

ContactSearchInputBox()

Initializes a new instance of the ContactSearchInputBox class.

Fields

IsClearEnabledProperty	Identifies the IsClearEnabled dependency property.
IsSkillSearchEnabledProperty	Identifies the IsSkillSearchEnabled dependency property.
MaxResultsProperty	Identifies the MaxResults dependency property.
ResultsProperty	Identifies the Results dependency property.
SearchStateProperty	Identifies the SearchState dependency property.
SearchTextInputProperty	Identifies the SearchTextInput dependency property.
SearchTypeProperty	Identifies the SearchType dependency property.

Properties

ContextMenu	(Inherited from UCBase)
InitializationError	(Inherited from UCBase)
InitializationErrorMessage	(Inherited from UCBase)
InitializationFailed	(Inherited from UCBase)
IsClearEnabled	Gets a bool that specifies whether the ClearButton is enabled.
IsInResiliencyMode	(Inherited from UCBase)
IsLoaded	(Inherited from UCBase)
IsLoadedAndIsInVisualTree	(Inherited from UCBase)
IsSignedIn	(Inherited from UCBase)
IsSkillSearchEnabled	Gets or sets a bool value which indicates whether or not the skill search feature is enabled.
MaxResults	Gets or sets the maximum number of results to return.
Results	Gets a SearchResultCollection object containing the results of a completed search operation.
SearchState	Gets a SearchState enumeration, which will specify either Cleared, Searching, Finished, or Error.
SearchTextInput	Gets or sets the search input text. When set, any current search operation is cancelled, search results are reset, and a new search operation is initiated.
SearchType	Gets or sets an enumerated value which determines the type of search to be performed by this control.
UCClientModel	(Inherited from UCBase)

Methods

ExtractTemplatePart<T>(String)	(Inherited from UCBase)
ExtractTemplatePart<T>(String, Boolean)	(Inherited from UCBase)
OnApplyTemplate()	When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application.
OnClientDisconnected()	(Inherited from UCBase)
OnContactManagerPropertyChanged(IContactsAndGroupsManagerModel, IContactsAndGroupsManagerModel)	Reserved for internal use.
OnCreateAutomationPeer()	Return the AutomationPeer object for the ContactSearchInputBox control.
OnIsInResiliencyModePropertyChanged(Boolean, Boolean)	(Inherited from UCBase)
OnIsSignedPropertyChanged(Boolean, Boolean)	Reserved for internal use.
OnLoaded()	(Inherited from UCBase)
OnSelfModelPropertyChanged(ISelfModel, ISelfModel)	(Inherited from UCBase)
OnUnloaded()	Reserved for internal use.
UnwireUCClient()	Reserved for internal use.
WireUCClient(IUCClientModel)	Reserved for internal use.

Events

InitializationCompleted

(Inherited from UCBase)