PasswordChar プロパティ (TextBoxCell)

TextBoxCellでパスワードの文字をマスクするために使用される文字を取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property PasswordChar As Char

public char PasswordChar {get; set;}

プロパティ値

TextBoxCellに入力された文字をマスクするために使用される文字を表すSystem.Char値。入力した文字をマスクしない場合は、値を'\0'（文字値）に設定します。既定値は'\0'です。

例外

例外	解説
System.InvalidOperationException	GcMultiRowのGcMultiRow.AllowClipboardプロパティがtrueで、このプロパティを使用している場合に、このセルで切り取りまたはコピー操作を実行しようとしました。

解説

UseSystemPasswordCharプロパティは、PasswordCharプロパティよりも優先されます。UseSystemPasswordCharがtrueに設定されている場合は常に、既定のシステムパスワード文字が使用され、PasswordCharで設定された文字は無視されます。

PasswordCharプロパティを使用している場合、このセルでキーボードを使用して切り取りまたはコピー操作を行うことはできません。そうすると、System.InvalidOperationExceptionがスローされます。この場合、クリップボードにはString.Emptyが設定されます。ただし、編集モードのときは標準コントロールと同じように動作します。

重要:
PasswordChar、UseSystemPasswordChar、またはReadOnlyがtrueに設定されている（または使用されている）ためにTextBoxCellがパスワードモードである場合、TextBoxCellは制限モードになります。このモードでは、ImeModeは無効ですが、現在のImeModeがキャッシュされるので、TextBoxCellが制限モードでなくなった場合にImeModeの値を復元できます。デザイナの観点から見ると、示されるImeModeの値は実際の値です。

重要:

PasswordChar、UseSystemPasswordChar、またはReadOnlyがtrueに設定されている（または使用されている）ためにTextBoxCellがパスワードモードである場合、TextBoxCellは制限モードになります。このモードでは、ImeModeは無効ですが、現在のImeModeがキャッシュされるので、TextBoxCellが制限モードでなくなった場合にImeModeの値を復元できます。デザイナの観点から見ると、示されるImeModeの値は実際の値です。

使用例

次のサンプルコードは、TextBoxCellの持ついくつかの重要なプロパティを示します。このセルにテキスト全体を表示できない場合は、省略記号文字列"......"が表示されます。HighlightTextがtrueに設定されているため、編集モードに入るとテキストが強調表示されます。また、MaxLengthが10に設定されているため、元のテキストを削除して別のテキストを入力する場合、入力できる文字数は10文字に制限されます。さらに、大文字のテキストは小文字に変換されます。このサンプルコードは、TextBoxCellに示されている詳細なコード例の一部を抜粋したものです。

C#
Visual Basic

private void Form1_Load(object sender, EventArgs e)
{
    TextBoxCell textBoxCell1 = new TextBoxCell();
    //If the text cannot display completely, one '......' string will be shown at the text's end, hover the cell, the whole text will be shown in tool tip.
    textBoxCell1.Ellipsis = MultiRowEllipsisMode.EllipsisEnd;
    textBoxCell1.EllipsisString = "......";
    //Enter the edit mode, the text will be highlight selected.
    textBoxCell1.HighlightText = true;
    textBoxCell1.Value = "DELETE THIS STRING TO INPUT BY YOURSELF, ONLY 10 CHARACTERS CAN BE INPUT";
    textBoxCell1.MaxLength = 10;
    //The value will be casted to lower case.
    textBoxCell1.CharacterCasing = CharacterCasing.Lower;

    TextBoxCell textBoxCell2 = new TextBoxCell();
    //Input text in textBoxCell2, it will be treated as password, always display '#'.
    textBoxCell2.PasswordChar = '#';
    textBoxCell2.UseSystemPasswordChar = false;
    textBoxCell2.Value = "12345";

    Template template1 = Template.CreateGridTemplate(new Cell[] { textBoxCell1, textBoxCell2 }, 160,
        AutoGenerateGridTemplateStyles.ColumnHeader | AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);

    gcMultiRow1.Template = template1;
    gcMultiRow1.RowCount = 3;
}

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    Dim textBoxCell1 As New TextBoxCell()
    'If the text cannot display completely, one '......' string will be shown at the text's end, hover the cell, the whole text will be shown in tool tip.
    textBoxCell1.Ellipsis = MultiRowEllipsisMode.EllipsisEnd
    textBoxCell1.EllipsisString = "......"
    'Enter the edit mode, the text will be highlight selected.
    textBoxCell1.HighlightText = True
    textBoxCell1.Value = "DELETE THIS STRING TO INPUT BY YOURSELF, ONLY 10 CHARACTERS CAN BE INPUT"
    textBoxCell1.MaxLength = 10
    'The value will be casted to lower case.
    textBoxCell1.CharacterCasing = CharacterCasing.Lower

    Dim textBoxCell2 As New TextBoxCell()
    'Input text in textBoxCell2, it will be treated as password, always display '#'.
    textBoxCell2.PasswordChar = "#"c
    textBoxCell2.UseSystemPasswordChar = False
    textBoxCell2.Value = "12345"

    Dim template1 As Template = Template.CreateGridTemplate(New Cell() {textBoxCell1, textBoxCell2})

    gcMultiRow1.Template = template1
    gcMultiRow1.RowCount = 3
End Sub

参照

TextBoxCell クラス
 TextBoxCell メンバ