Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
289 lines (275 sloc) 16 KB
<Type Name="IDesignerEventService" FullName="System.ComponentModel.Design.IDesignerEventService">
<TypeSignature Language="C#" Value="public interface IDesignerEventService" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDesignerEventService" />
<TypeSignature Language="DocId" Value="T:System.ComponentModel.Design.IDesignerEventService" />
<TypeSignature Language="VB.NET" Value="Public Interface IDesignerEventService" />
<TypeSignature Language="C++ CLI" Value="public interface class IDesignerEventService" />
<TypeSignature Language="F#" Value="type IDesignerEventService = interface" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>Provides event notifications when root designers are added and removed, when a selected component changes, and when the current root designer changes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.ComponentModel.Design.IDesignerEventService> provides notification when a new root designer is created, changed, or disposed. A root designer provides design time support for the base component of a document in designer view. The <xref:System.ComponentModel.Design.IDesignerEventService.SelectionChanged> event provides notification when the current component selection has changed.
## Examples
This example demonstrates a designer that uses the <xref:System.ComponentModel.Design.IDesignerEventService> to display event notifications on a control. To use this example, compile the code to a class library. Add a reference to the library to a new Windows Forms project, and add the control within the library to the **Toolbox**. Add an instance of the `DesignerMonitor` control to a form in design mode. Right-click the control and click the `Start monitoring` command to display notifications of events raised by the <xref:System.ComponentModel.Design.IDesignerEventService>.
[!code-cpp[IDesignerEventServiceExample#1](~/samples/snippets/cpp/VS_Snippets_Winforms/IDesignerEventServiceExample/CPP/source.cpp#1)]
[!code-vb[IDesignerEventServiceExample#1](~/samples/snippets/visualbasic/VS_Snippets_Winforms/IDesignerEventServiceExample/VB/source.vb#1)]
]]></format>
</remarks>
<altmember cref="T:System.ComponentModel.Design.DesignerEventHandler" />
</Docs>
<Members>
<Member MemberName="ActiveDesigner">
<MemberSignature Language="C#" Value="public System.ComponentModel.Design.IDesignerHost ActiveDesigner { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Design.IDesignerHost ActiveDesigner" />
<MemberSignature Language="DocId" Value="P:System.ComponentModel.Design.IDesignerEventService.ActiveDesigner" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActiveDesigner As IDesignerHost" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::ComponentModel::Design::IDesignerHost ^ ActiveDesigner { System::ComponentModel::Design::IDesignerHost ^ get(); };" />
<MemberSignature Language="F#" Value="member this.ActiveDesigner : System.ComponentModel.Design.IDesignerHost" Usage="System.ComponentModel.Design.IDesignerEventService.ActiveDesigner" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.IDesignerHost</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the root designer for the currently active document.</summary>
<value>The currently active document, or <see langword="null" /> if there is no active document.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActiveDesignerChanged">
<MemberSignature Language="C#" Value="event System.ComponentModel.Design.ActiveDesignerEventHandler ActiveDesignerChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.ComponentModel.Design.ActiveDesignerEventHandler ActiveDesignerChanged" />
<MemberSignature Language="DocId" Value="E:System.ComponentModel.Design.IDesignerEventService.ActiveDesignerChanged" />
<MemberSignature Language="VB.NET" Value="Event ActiveDesignerChanged As ActiveDesignerEventHandler " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; event System::ComponentModel::Design::ActiveDesignerEventHandler ^ ActiveDesignerChanged;" />
<MemberSignature Language="F#" Value="member this.ActiveDesignerChanged : System.ComponentModel.Design.ActiveDesignerEventHandler " Usage="member this.ActiveDesignerChanged : System.ComponentModel.Design.ActiveDesignerEventHandler " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.ActiveDesignerEventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the current root designer changes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event can result from the user opening or setting focus to a new document, or by closing a document.
]]></format>
</remarks>
<altmember cref="T:System.ComponentModel.Design.ActiveDesignerEventHandler" />
<altmember cref="T:System.ComponentModel.Design.ActiveDesignerEventArgs" />
</Docs>
</Member>
<Member MemberName="DesignerCreated">
<MemberSignature Language="C#" Value="event System.ComponentModel.Design.DesignerEventHandler DesignerCreated;" />
<MemberSignature Language="ILAsm" Value=".event class System.ComponentModel.Design.DesignerEventHandler DesignerCreated" />
<MemberSignature Language="DocId" Value="E:System.ComponentModel.Design.IDesignerEventService.DesignerCreated" />
<MemberSignature Language="VB.NET" Value="Event DesignerCreated As DesignerEventHandler " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; event System::ComponentModel::Design::DesignerEventHandler ^ DesignerCreated;" />
<MemberSignature Language="F#" Value="member this.DesignerCreated : System.ComponentModel.Design.DesignerEventHandler " Usage="member this.DesignerCreated : System.ComponentModel.Design.DesignerEventHandler " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.DesignerEventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when a root designer is created.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event is raised when a new document has been loaded and is ready for user input.
]]></format>
</remarks>
<altmember cref="T:System.ComponentModel.Design.DesignerEventHandler" />
<altmember cref="T:System.ComponentModel.Design.DesignerEventArgs" />
</Docs>
</Member>
<Member MemberName="DesignerDisposed">
<MemberSignature Language="C#" Value="event System.ComponentModel.Design.DesignerEventHandler DesignerDisposed;" />
<MemberSignature Language="ILAsm" Value=".event class System.ComponentModel.Design.DesignerEventHandler DesignerDisposed" />
<MemberSignature Language="DocId" Value="E:System.ComponentModel.Design.IDesignerEventService.DesignerDisposed" />
<MemberSignature Language="VB.NET" Value="Event DesignerDisposed As DesignerEventHandler " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; event System::ComponentModel::Design::DesignerEventHandler ^ DesignerDisposed;" />
<MemberSignature Language="F#" Value="member this.DesignerDisposed : System.ComponentModel.Design.DesignerEventHandler " Usage="member this.DesignerDisposed : System.ComponentModel.Design.DesignerEventHandler " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.DesignerEventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when a root designer for a document is disposed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event is raised when a document is about to be disposed, but before the document actually starts to dispose itself.
]]></format>
</remarks>
<altmember cref="T:System.ComponentModel.Design.DesignerEventHandler" />
<altmember cref="T:System.ComponentModel.Design.DesignerEventArgs" />
</Docs>
</Member>
<Member MemberName="Designers">
<MemberSignature Language="C#" Value="public System.ComponentModel.Design.DesignerCollection Designers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Design.DesignerCollection Designers" />
<MemberSignature Language="DocId" Value="P:System.ComponentModel.Design.IDesignerEventService.Designers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Designers As DesignerCollection" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::ComponentModel::Design::DesignerCollection ^ Designers { System::ComponentModel::Design::DesignerCollection ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Designers : System.ComponentModel.Design.DesignerCollection" Usage="System.ComponentModel.Design.IDesignerEventService.Designers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.DesignerCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of root designers for design documents that are currently active in the development environment.</summary>
<value>A <see cref="T:System.ComponentModel.Design.DesignerCollection" /> containing the root designers that have been created and not yet disposed.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SelectionChanged">
<MemberSignature Language="C#" Value="event EventHandler SelectionChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler SelectionChanged" />
<MemberSignature Language="DocId" Value="E:System.ComponentModel.Design.IDesignerEventService.SelectionChanged" />
<MemberSignature Language="VB.NET" Value="Event SelectionChanged As EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; event EventHandler ^ SelectionChanged;" />
<MemberSignature Language="F#" Value="member this.SelectionChanged : EventHandler " Usage="member this.SelectionChanged : System.EventHandler " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ComponentModel.TypeConverter</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the current design-view selection changes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This selection changed event can result from the user changing the selection in the currently active document, or from the user switching to a new document.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.