IsExtentBasedOnValue Method (ValueEditor)

Indicates whether the desired width or the height of the editor is based on the value.

Syntax

Visual Basic

'Declaration
 
Public Overridable Function IsExtentBasedOnValue( _
   ByVal orientation As Orientation _
) As Boolean

C#

public virtual bool IsExtentBasedOnValue( 
   Orientation orientation
)

Parameters

orientation

Orientation of the extent being evaluated. Horizontal indicates the width and vertical indicates the height.

Return Value

True if the extent is based on the value.

Remarks

This method is used by the Infragistics internal infrastructure to determine if an editor's desired size changes based on the value of the editor. For example, XamCheckEditor returns False for both orientation since its width and height both are not related to its value. Whether the value of a XamCheckEditor is True or Flase, it will be the same width and height. XamTextEditor on the other hand returns True for the horizontal orientation since since the desired size depends on the current value in the editor. It returns True or False for the vertical dimension based on whether wrapping is turned on or off respectively.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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