GetText メソッド

指定されたマスクモードを使用して、オブジェクトのテキストを返します。

シンタックス

Visual Basic

'宣言
 
Public Function GetText( _
   ByVal maskMode As Infragistics.Win.UltraWinMaskedEdit.MaskMode _
) As String

C#

public string GetText( 
   Infragistics.Win.UltraWinMaskedEdit.MaskMode maskMode
)

パラメータ

maskMode

返されるテキストを決定するために使用されるマスク モード。

戻り値の型

指定されたマスクモードを使用して、オブジェクトのテキスト。

解説

オブジェクトのテキストを特定の書式で扱う必要があるときに、マスキング プロパティ (MaskClipMode、MaskDataMode、またはMaskDisplayMode) の設定を変更したくない場合があります。たとえば、リテラルとプロンプト文字をすべて含む形式でオブジェクトのテキストを取得したいが、データベースへのデータの送信方法を変更したり、クリップボードを使用したりはしたくない場合などです。このような要求に対応することが GetText メソッドの目的です。

GetText はオブジェクトのテキストを含む文字列の値を、指定した書式で返します。GetText メソッドを呼び出すときは、オブジェクトのテキストをどのような書式で受け取るのかを指定するmaskmodeパラメーターを渡します。これにより、オブジェクトのマスキング プロパティの設定を無視して、プロンプト文字やリテラルを含むか、またはユーザーが入力した生のテキストのみにするかをその場限りで指定できます。

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid
Imports System.Diagnostics

   Private Sub Button17_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button17.Click

       ' Enable masked input in a column by setting the MaskInput property.
       Dim column As UltraGridColumn = Me.UltraGrid1.DisplayLayout.Bands(0).Columns("Phone")
       column.MaskInput = "(###) ###-####"

       ' Set the MaskDataMode to Raw.
       column.MaskDataMode = MaskMode.Raw

       ' Get a cell in the coumn to demonstrate the mask modes.
       Dim cell As UltraGridCell = Me.UltraGrid1.Rows(0).Cells(column)

       ' Assing a cell value that partially fills the specified mask.
       cell.Value = "123"

       Debug.WriteLine("Cell.Text = " & cell.Text)
       Debug.WriteLine("Cell.GetText( MaskMode.Raw ) = " & cell.GetText(MaskMode.Raw))
       Debug.WriteLine("Cell.GetText( MaskMode.IncludeLiterals ) = " & cell.GetText(MaskMode.IncludeLiterals))
       Debug.WriteLine("Cell.GetText( MaskMode.IncludeLiteralsWithPadding ) = " & cell.GetText(MaskMode.IncludeLiteralsWithPadding))
       Debug.WriteLine("Cell.GetText( MaskMode.IncludeLiteralsWithPadding ) = " & cell.GetText(MaskMode.IncludePromptChars))
       Debug.WriteLine("Cell.GetText( MaskMode.IncludeBoth ) = " & cell.GetText(MaskMode.IncludeBoth))

   End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button17_Click(object sender, System.EventArgs e)
{

	// Enable masked input in a column by setting the MaskInput property.
	UltraGridColumn column = this.ultraGrid1.DisplayLayout.Bands[0].Columns["Phone"];
	column.MaskInput = "(###) ###-####";

	// Set the MaskDataMode to Raw.
	column.MaskDataMode    = MaskMode.Raw;

	// Get a cell in the coumn to demonstrate the mask modes.
	UltraGridCell cell = this.ultraGrid1.Rows[0].Cells[column];

	// Assing a cell value that partially fills the specified mask.
	cell.Value = "123";

	Debug.WriteLine( "Cell.Text = " + cell.Text );
	Debug.WriteLine( "Cell.GetText( MaskMode.Raw ) = " + cell.GetText( MaskMode.Raw ) );
	Debug.WriteLine( "Cell.GetText( MaskMode.IncludeLiterals ) = " + cell.GetText( MaskMode.IncludeLiterals ) );
	Debug.WriteLine( "Cell.GetText( MaskMode.IncludeLiteralsWithPadding ) = " + cell.GetText( MaskMode.IncludeLiteralsWithPadding ) );
	Debug.WriteLine( "Cell.GetText( MaskMode.IncludeLiteralsWithPadding ) = " + cell.GetText( MaskMode.IncludePromptChars ) );
	Debug.WriteLine( "Cell.GetText( MaskMode.IncludeBoth ) = " + cell.GetText( MaskMode.IncludeBoth ) );

}