InitEventArgs Class
NOTE: This API is now obsolete.
Represents the object type returned by the WebPart.GetInitEventArgs method.
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
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
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
The following code example shows an overridden GetInitEventArgs method that returns an instance of the InitEventArgs class. This code example is part of a larger example provided for the IFilterConsumer interface.
// 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); } }