ComparesByValue Method (EmbeddableEditorBase)

Returns whether the owner should compare items based on their underlying value rather than their display text.

Syntax

Visual Basic

'Declaration
 
Public Overridable Function ComparesByValue( _
   ByVal owner As EmbeddableEditorOwnerBase, _
   ByVal ownerContext As Object _
) As Boolean

C#

public virtual bool ComparesByValue( 
   EmbeddableEditorOwnerBase owner,
   object ownerContext
)

Parameters

owner

The EmbeddableEditorOwnerBase-derived owner

ownerContext

The context that was passed into the GetEmbeddableElement(UIElement,EmbeddableEditorOwnerBase,Object,EmbeddableUIElementBase) method.

Return Value

True if the owner should compare items based on their underlying value.

Remarks

The default implementation returns true, implying that the owner should sort by the underlying data value.

Editors that support ValueLists will look at the owner's return from GetValueList; if an IValueList is supplied, the value of the SortByValue property will be returned.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2