DataObjectMemberComparer.Compare Method (String, String, Object, Object)
Compares a property of a data object with another data object property.
Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)
Syntax
'Declaration
Public Overridable Function Compare ( _
typeName As String, _
propertyName As String, _
value1 As Object, _
value2 As Object _
) As Integer
public virtual int Compare(
string typeName,
string propertyName,
Object value1,
Object value2
)
public:
virtual int Compare(
String^ typeName,
String^ propertyName,
Object^ value1,
Object^ value2
)
abstract Compare :
typeName:string *
propertyName:string *
value1:Object *
value2:Object -> int
override Compare :
typeName:string *
propertyName:string *
value1:Object *
value2:Object -> int
public function Compare(
typeName : String,
propertyName : String,
value1 : Object,
value2 : Object
) : int
Parameters
typeName
Type: System.StringThe name of an object type.
propertyName
Type: System.StringThe name of a property to compare.
value1
Type: System.ObjectThe first value to compare.
value2
Type: System.ObjectThe second value to compare.
Return Value
Type: System.Int32
A value less than zero if the identifier part is less than the specified value; zero if the identifier part is equal to the specified value; a value greater than zero if the identifier part is greater than the specified value.
Implements
IVsDataObjectMemberComparer.Compare(String, String, Object, Object)
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The typeName and/or propertyName parameter is nulla null reference (Nothing in Visual Basic). |
Remarks
This method should use the same comparison rules as the data source to ensure the correct sorting of objects on the client side.
The base implementation of this method uses the default .NET Framework object comparer (Comparer) when the first value implements IComparable; otherwise it calls the IComparable implementation's override Equals method and returns 1 if this returns false.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.