GetLabelValueHolder(Int32) メソッド

フィールド ラベルをクリップボードに挿入する場合に使用される値の Infragistics.Windows.DataPresenter.CellValueHolder を返します。

シンタックス

Visual Basic

'宣言
 
Public Overloads Function GetLabelValueHolder( _
   ByVal column As Integer _
) As CellValueHolder

C#

public CellValueHolder GetLabelValueHolder( 
   int column
)

パラメータ

column

Infragistics.Windows.DataPresenter.CellValueHolder が要求されているフィールドの 0 から始まるインデックス。

戻り値の型

CellValueHolder です。フィールド ラベルがクリップボードの出力に含まれない場合は null です。

解説

セルがクリップボードにコピーされると、フィールド ラベルは、CopyFieldLabelsToClipboard の値に基づいて任意に出力に含まれます。このメソッドを使用すると、指定したフィールドのためにクリップボードに出力するテキストを提供できます。これは、Infragistics.Windows.DataPresenter.FieldItem.Label が文字列以外の値に設定されている場合に便利です。

使用例

Visual Basic

Imports Infragistics.Windows.DataPresenter

    Private Sub grid_ClipboardCopying(ByVal sender As System.Object, ByVal e As Infragistics.Windows.DataPresenter.Events.ClipboardCopyingEventArgs)
        For i As Integer = 0 To e.FieldCount - 1
            Dim field As Field = e.GetSourceField(i)
            Dim labelValue As CellValueHolder = e.GetLabelValueHolder(i)

            ' the display uses shortened names for the labels in the 
            ' display but we want to put more verbose descriptions in
            ' the clipboard
            If field.Name = "salary" Then
                labelValue.Value = "Salary"
                labelValue.IsDisplayText = True
            ElseIf field.Name = "department" Then
                labelValue.Value = "Department"
                labelValue.IsDisplayText = True
            End If
        Next
    End Sub

C#

using Infragistics.Windows.DataPresenter;

		private void grid_ClipboardCopying(object sender, Infragistics.Windows.DataPresenter.Events.ClipboardCopyingEventArgs e)
		{
			for (int i = 0; i < e.FieldCount; i++)
			{
				Field field = e.GetSourceField(i);
				CellValueHolder labelValue = e.GetLabelValueHolder(i);

				// the display uses shortened names for the labels in the 
				// display but we want to put more verbose descriptions in
				// the clipboard
				if (field.Name == "salary")
				{
					labelValue.Value = "Salary";
					labelValue.IsDisplayText = true;
				}
				else if (field.Name == "department")
				{
					labelValue.Value = "Department";
					labelValue.IsDisplayText = true;
				}
			}
		}

XAML

xmlns:igDP="http://infragistics.com/DataPresenter"

<igDP:XamDataGrid 
    x:Name="grid" 
    BindToSampleData="True"
    ClipboardCopying="grid_ClipboardCopying">
    <igDP:XamDataGrid.FieldLayoutSettings>
        <igDP:FieldLayoutSettings 
            AllowClipboardOperations="All" 
            CopyFieldLabelsToClipboard="True"/>
    </igDP:XamDataGrid.FieldLayoutSettings>
    <igDP:XamDataGrid.FieldLayouts>
        <igDP:FieldLayout>
            <igDP:FieldLayout.Fields>
                <igDP:Field Name="name" Label="Name"/>
                <igDP:Field Name="salary" Label="$"/>
                <igDP:Field Name="department" Label="Dept"/>
                <igDP:Field Name="email" Label="Email"/>
            </igDP:FieldLayout.Fields>
        </igDP:FieldLayout>
    </igDP:XamDataGrid.FieldLayouts>
</igDP:XamDataGrid>