InitEventArgs - Classe

Article
05/12/2015

Remarque : cette API est désormais obsolète.

Représente le type d'objet retourné par la méthode WebPart.GetInitEventArgs .

Hiérarchie d’héritage

System.Object
  System.EventArgs
    Microsoft.SharePoint.WebPartPages.Communication.InitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.CellConsumerInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.CellProviderInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.FilterConsumerInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.ListProviderInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.ParametersInConsumerInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.ParametersOutProviderInitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.RowProviderInitEventArgs

Espace de noms : Microsoft.SharePoint.WebPartPages.Communication
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")> _
Public Class InitEventArgs _
    Inherits EventArgs
'Utilisation
Dim instance As InitEventArgs

[ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")]
public class InitEventArgs : EventArgs

Exemples

L'exemple de code suivant montre une méthode substituée GetInitEventArgs qui retourne une instance de la classe InitEventArgs . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IFilterConsumer .

' Step #8: Override the GetInitEventArgs method.
' GetInitEventArgs() is called by the Web Part infrastructure during 
' the ASP.NET PreRender event to gather the 
' necessary information it needs to build the transformer dialog. The 
' transformer dialog is needed when connecting different interfaces 
' such as IRowProvider to ICellConsumer. The transformer dialog allows 
' the user to map the fields between the interfaces. The 
' GetInitEventArgs()method only needs to be implemented for interfaces 
' that can participate in a transformer which are the following:
' ICellConsumer, IRowProvider, IFilterConsumer, IParametersOutProvider, 
' IParametersInConsumer.
' <param name="interfacename">Name of interface on which the Web Part 
' infrastructure is requesting information</param>
' <returns>An InitEventArgs object</returns>
Public Overrides Function GetInitEventArgs(interfaceName As String) As InitEventArgs
   ' Check if this is my particular cell interface.
   If interfaceName = "MyFilterConsumerInterface" Then
      'Ensure that all of the Web Part's controls are created.
      'The _filterFieldNames and _filterFieldDisplayNames are set during EnsureChildControls()
      EnsureChildControls()
          
      ' Create the FilterConsumerInitEventArgs object for the FilterConsumerInit event.
      Dim filterConsumerInitArgs As New FilterConsumerInitEventArgs()
            
      ' Set the field names
      filterConsumerInitArgs.FieldList = _filterFieldNames
      filterConsumerInitArgs.FieldDisplayList = _filterFieldDisplayNames
            
      ' return the FilterConsumerInitEventArgs. 
      Return filterConsumerInitArgs
   Else
      Return Nothing
   End If
End Function

// Step #8: Override the GetInitEventArgs method.
// GetInitEventArgs() is called by the Web Part infrastructure during 
// the ASP.NET PreRender event to gather the 
// necessary information it needs to build the transformer dialog. The 
// transformer dialog is needed when connecting different interfaces 
// such as IRowProvider to ICellConsumer. The transformer dialog allows 
// the user to map the fields between the interfaces. The 
// GetInitEventArgs()method only needs to be implemented for interfaces 
// that can participate in a transformer which are the following:
// ICellConsumer, IRowProvider, IFilterConsumer, 
// IParametersOutProvider, IParametersInConsumer.
// <param name="interfacename">Name of interface on which the Web Part 
// infrastructure is requesting information</param>
// <returns>An InitEventArgs object</returns>
public override InitEventArgs GetInitEventArgs(string interfaceName)
{
    // Check if this is my particular cell interface.
    if (interfaceName == "MyFilterConsumerInterface")
    {
        //Ensure that all of the Web Part's controls are created.
        //The _filterFieldNames and _filterFieldDisplayNames are set 
        //during EnsureChildControls()
        EnsureChildControls();

        // Create the FilterConsumerInitEventArgs object for the 
        // FilterConsumerInit event.
        FilterConsumerInitEventArgs filterConsumerInitArgs = new FilterConsumerInitEventArgs();
                    
        // Set the field names
        filterConsumerInitArgs.FieldList = _filterFieldNames;
        filterConsumerInitArgs.FieldDisplayList = _filterFieldDisplayNames;
            
        // return the FilterConsumerInitEventArgs. 
        return(filterConsumerInitArgs);
    }
    else
    {
        return(null);
    }
}

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

InitEventArgs - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Partager via