CellConsumerInitEventArgs.FieldName property

Artigo
05/12/2015

NOTE: This API is now obsolete.

Obtém ou define o nome da célula.

Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Property FieldName As String
    Get
    Set
'Uso
Dim instance As CellConsumerInitEventArgs
Dim value As String

value = instance.FieldName

instance.FieldName = value

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public string FieldName { get; set; }

Property value

Type: System.String
Uma seqüência de caracteres que representa o nome da célula. Se o FieldDisplayName não for especificado, ele será exibido na interface do usuário.

Examples

O exemplo de código a seguir mostra um método substituído WebPart.PartCommunicationInit que cria um objeto CellConsumerInitEventArgs , define as propriedades FieldName e FieldDisplayName e dispara o evento CellConsumerInit . Este exemplo de código é parte de um exemplo maior fornecido para a interface ICellConsumer .

' Step #10: Override the PartCommunicationInit() method.
' PartCommunicationInit() is called by the Web Part infrastructure 
' during the ASP.NET PreRender event to allow the part to pass 
' initialization information to the other connected parts.
' It is important to always pass initialization information as some 
' parts may not behave properly if this initialization information is 
' not received.
Public Overrides Sub PartCommunicationInit()
    ' Check if connected.
    If _connected Then
        ' Create the CellConsumerInitEventArgs structure for the 
        ' CellConsumerInit event.
        Dim cellConsumerInitArgs As New CellConsumerInitEventArgs()

        ' Set the FieldName and FieldDisplayName values.
        cellConsumerInitArgs.FieldName = _cellName
        cellConsumerInitArgs.FieldDisplayName = _cellDisplayName

        ' Fire the CellConsumerInit event.
        RaiseEvent CellConsumerInit(Me, cellConsumerInitArgs)
    End If
End Sub

// Step #10: Override the PartCommunicationInit() method.
// PartCommunicationInit() is called by the Web Part infrastructure 
// during the ASP.NET PreRender event to allow the part to pass 
// initialization information to the other connected parts.
// It is important to always pass initialization information as some 
// parts may not behave properly if this initialization information is 
// not received.
public override void PartCommunicationInit()
{
    // Check if connected.
    if(_connected)
    {
        // If there is a listener, fire the CellConsumerInit event.
        if (CellConsumerInit != null)
        {
            // Create the CellConsumerInitEventArgs structure for the 
            // CellConsumerInit event.
            CellConsumerInitEventArgs cellConsumerInitArgs = 
                new CellConsumerInitEventArgs();
            
            // Set the FieldName and FieldDisplayName values.
            cellConsumerInitArgs.FieldName = _cellName;
            cellConsumerInitArgs.FieldDisplayName = _cellDisplayName;

            // Fire the CellConsumerInit event.
            CellConsumerInit(this, cellConsumerInitArgs);
        }
    }
}

Ver também

Referência

CellConsumerInitEventArgs class

CellConsumerInitEventArgs members

Microsoft.SharePoint.WebPartPages.Communication namespace

Compartilhar via