IExtenderProviderService インターフェイス

[アーティクル]
08/14/2007

デザイン時に拡張プロバイダを追加または削除するためのインターフェイスを提供します。

名前空間: System.ComponentModel.Design
アセンブリ: System (system.dll 内)

構文

'宣言
Public Interface IExtenderProviderService
'使用
Dim instance As IExtenderProviderService

public interface IExtenderProviderService

public interface class IExtenderProviderService

public interface IExtenderProviderService

public interface IExtenderProviderService

解説

通常、拡張プロバイダを提供するのは、コンテナに追加されているコンポーネントだけです。IExtenderProviderService を使用すると、コンテナ内にないオブジェクトでも拡張プロバイダを提供できるようになります。

使用例

デザイナの IExtenderProviderService を使用して、IExtenderProvider 実装の追加と削除を行う例を次に示します。

Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Windows.Forms
Imports System.Windows.Forms.Design

' This designer adds a ComponentExtender extender provider, 
' and removes it when the designer is destroyed.
Public Class ExtenderServiceDesigner
    Inherits System.Windows.Forms.Design.ControlDesigner

   ' A local reference to an obtained IExtenderProviderService.
   Private localExtenderServiceReference As IExtenderProviderService
   ' An IExtenderProvider that this designer supplies.
   Private extender As ComponentExtender   
   
   Public Sub New()
    End Sub

    Public Overrides Sub Initialize(ByVal component As System.ComponentModel.IComponent)
        MyBase.Initialize(component)

        ' Attempts to obtain an IExtenderProviderService.
        Dim extenderService As IExtenderProviderService = CType(component.Site.GetService(GetType(IExtenderProviderService)), IExtenderProviderService)
        If Not (extenderService Is Nothing) Then
            ' If the service was obtained, adds a ComponentExtender 
            ' that adds an "ExtenderIndex" integer property to the 
            ' designer's component.
            extender = New ComponentExtender()
            extenderService.AddExtenderProvider(extender)
            localExtenderServiceReference = extenderService
        Else
            MessageBox.Show("Could not obtain an IExtenderProviderService.")
        End If
    End Sub

    Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
        ' Removes any previously added extender provider.
        If Not (localExtenderServiceReference Is Nothing) Then
            localExtenderServiceReference.RemoveExtenderProvider(extender)
            localExtenderServiceReference = Nothing
        End If
    End Sub
End Class

' IExtenderProviderImplementation that adds an integer property 
' named "ExtenderIndex" to any design-mode document object.
<ProvidePropertyAttribute("ExtenderIndex", GetType(IComponent))> _
Public Class ComponentExtender
    Implements System.ComponentModel.IExtenderProvider

    ' Stores the value of the property to extend a component with.
    Public index As Integer = 0

    Public Sub New()
    End Sub

    ' Extends any type of object.
    Public Function CanExtend(ByVal extendee As Object) As Boolean Implements IExtenderProvider.CanExtend
        Return True
    End Function

    Public Function GetExtenderIndex(ByVal component As IComponent) As Integer
        Return index
    End Function

    Public Sub SetExtenderIndex(ByVal component As IComponent, ByVal index As Integer)
        Me.index = index
    End Sub
End Class

' Example UserControl associated with the ExtenderServiceDesigner.
<DesignerAttribute(GetType(ExtenderServiceDesigner))> _
Public Class ExtenderServiceTestControl
    Inherits System.Windows.Forms.UserControl

    Public Sub New()
    End Sub
End Class

using System;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Windows.Forms;
using System.Windows.Forms.Design;

namespace ExtenderServiceExample
{    
    // This designer adds a ComponentExtender extender provider, 
    // and removes it when the designer is destroyed.
    public class ExtenderServiceDesigner : System.Windows.Forms.Design.ControlDesigner
    {
        // A local reference to an obtained IExtenderProviderService.
        private IExtenderProviderService localExtenderServiceReference;
        // An IExtenderProvider that this designer supplies.
        private ComponentExtender extender;
        
        public ExtenderServiceDesigner()
        {
        }

        public override void Initialize(System.ComponentModel.IComponent component)
        {
            base.Initialize(component);

            // Attempts to obtain an IExtenderProviderService.
            IExtenderProviderService extenderService = (IExtenderProviderService)component.Site.GetService(typeof(IExtenderProviderService));
            if( extenderService != null )
            {
                // If the service was obtained, adds a ComponentExtender 
                // that adds an "ExtenderIndex" integer property to the 
                // designer's component.
                extender = new ComponentExtender();                
                extenderService.AddExtenderProvider( extender );
                localExtenderServiceReference = extenderService;
            }
            else
                MessageBox.Show("Could not obtain an IExtenderProviderService.");
        }

        protected override void Dispose(bool disposing)
        {
            // Removes any previously added extender provider.
            if( localExtenderServiceReference != null )
            {
                localExtenderServiceReference.RemoveExtenderProvider( extender );
                localExtenderServiceReference = null;
            }            
        }
    }
    
    // IExtenderProviderImplementation that adds an integer property 
    // named "ExtenderIndex" to any design-mode document object.
    [ProvidePropertyAttribute("ExtenderIndex", typeof(IComponent))]
    public class ComponentExtender : System.ComponentModel.IExtenderProvider
    {
        // Stores the value of the property to extend a component with.
        public int index = 0;        
    
        public ComponentExtender()
        {
        }

        public bool CanExtend(object extendee)
        {         
            // Extends any type of object.
            return true;
        }

        public int GetExtenderIndex(IComponent component)
        {
            return index;
        }

        public void SetExtenderIndex(IComponent component, int index)
        {
            this.index = index;
        }
    }

    // Example UserControl associated with the ExtenderServiceDesigner.
    [DesignerAttribute(typeof(ExtenderServiceDesigner))]
    public class ExtenderServiceTestControl : System.Windows.Forms.UserControl
    {       
        public ExtenderServiceTestControl()
        {                       
        }
    }
}

#using <system.dll>
#using <system.design.dll>
#using <system.windows.forms.dll>
#using <system.drawing.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Windows::Forms;
using namespace System::Windows::Forms::Design;

// IExtenderProviderImplementation that adds an integer property
// named "ExtenderIndex" to any design-mode document object.

[ProvidePropertyAttribute("ExtenderIndex",IComponent::typeid)]
public ref class ComponentExtender: public IExtenderProvider
{
public:

   // Stores the value of the property to extend a component with.
   int index;
   ComponentExtender()
   {
      index = 0;
   }

   virtual bool CanExtend( Object^ /*extendee*/ )
   {
      // Extends any type of object.
      return true;
   }

   int GetExtenderIndex( IComponent^ /*component*/ )
   {
      return index;
   }

   void SetExtenderIndex( IComponent^ /*component*/, int index )
   {
      this->index = index;
   }
};


// This designer adds a ComponentExtender extender provider,
// and removes it when the designer is destroyed.
public ref class ExtenderServiceDesigner: public ControlDesigner
{
private:

   // A local reference to an obtained IExtenderProviderService.
   IExtenderProviderService^ localExtenderServiceReference;

   // An IExtenderProvider that this designer supplies.
   ComponentExtender^ extender;

public:
   ExtenderServiceDesigner(){}

   virtual void Initialize( IComponent^ component ) override
   {
      ControlDesigner::Initialize( component );

      // Attempts to obtain an IExtenderProviderService.
      IExtenderProviderService^ extenderService = dynamic_cast<IExtenderProviderService^>(component->Site->GetService( IExtenderProviderService::typeid ));
      if ( extenderService != nullptr )
      {
         // If the service was obtained, adds a ComponentExtender
         // that adds an "ExtenderIndex" integer property to the
         // designer's component.
         extender = gcnew ComponentExtender;
         extenderService->AddExtenderProvider( extender );
         localExtenderServiceReference = extenderService;
      }
      else
            MessageBox::Show( "Could not obtain an IExtenderProviderService." );
   }

   ~ExtenderServiceDesigner()
   {
      // Removes any previously added extender provider.
      if ( localExtenderServiceReference != nullptr )
      {
         localExtenderServiceReference->RemoveExtenderProvider( extender );
         localExtenderServiceReference = nullptr;
      }
   }
};

// Example UserControl associated with the ExtenderServiceDesigner.

[DesignerAttribute(ExtenderServiceDesigner::typeid)]
public ref class ExtenderServiceTestControl: public UserControl
{
public:
   ExtenderServiceTestControl(){}
};

package ExtenderServiceExample;
import System.*;
import System.Collections.*;
import System.ComponentModel.*;
import System.ComponentModel.Design.*;
import System.Windows.Forms.*;
import System.Windows.Forms.Design.*;

// This designer adds a ComponentExtender extender provider, 
// and removes it when the designer is destroyed.
public class ExtenderServiceDesigner extends 
    System.Windows.Forms.Design.ControlDesigner
{
    // A local reference to an obtained IExtenderProviderService.
    private IExtenderProviderService localExtenderServiceReference;

    // An IExtenderProvider that this designer supplies.
    private ComponentExtender extender;

    public ExtenderServiceDesigner()
    {
    } //ExtenderServiceDesigner

    public void Initialize(System.ComponentModel.IComponent component)
    {
        super.Initialize(component);

        // Attempts to obtain an IExtenderProviderService.
        IExtenderProviderService extenderService = (IExtenderProviderService)
            component.get_Site().GetService(IExtenderProviderService.class.
            ToType());
        if (extenderService != null) {
            // If the service was obtained, adds a ComponentExtender 
            // that adds an "ExtenderIndex" integer property to the 
            // designer's component.
            extender = new ComponentExtender();
            extenderService.AddExtenderProvider(extender);
            localExtenderServiceReference = extenderService;
        }
        else {
            MessageBox.Show("Could not obtain an IExtenderProviderService.");
        }
    } //Initialize

    protected void Dispose(boolean disposing)
    {
        // Removes any previously added extender provider.
        if (localExtenderServiceReference != null) {
            localExtenderServiceReference.RemoveExtenderProvider(extender);
            localExtenderServiceReference = null;
        }
    } //Dispose
} //ExtenderServiceDesigner

// IExtenderProviderImplementation that adds an integer property 
// named "ExtenderIndex" to any design-mode document object.
/** @ attribute ProvidePropertyAttribute("ExtenderIndex", 
    IComponent.class.ToType())
 */
public class ComponentExtender implements 
    System.ComponentModel.IExtenderProvider
{
    // Stores the value of the property to extend a component with.
    public int index = 0;

    public ComponentExtender()
    {
    } //ComponentExtender

    public boolean CanExtend(Object extendee)
    {
        // Extends any type of object.
        return true;
    } //CanExtend

    public int GetExtenderIndex(IComponent component)
    {
        return index;
    } //GetExtenderIndex

    public void SetExtenderIndex(IComponent component, int index)
    {
        this.index = index;
    } //SetExtenderIndex
} //ComponentExtender

// Example UserControl associated with the ExtenderServiceDesigner.
/** @ attribute DesignerAttribute(ExtenderServiceDesigner.class.ToType())
 */
public class ExtenderServiceTestControl extends 
    System.Windows.Forms.UserControl
{
    public ExtenderServiceTestControl()
    {
    } //ExtenderServiceTestControl
} //ExtenderServiceTestControl

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework

サポート対象 : 2.0、1.1、1.0

次の方法で共有

IExtenderProviderService インターフェイス

構文

解説

使用例

プラットフォーム

バージョン情報

.NET Framework

参照

関連項目

その他のリソース