Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
264 lines (256 sloc) 16.7 KB
<Type Name="HwndTarget" FullName="System.Windows.Interop.HwndTarget">
<TypeSignature Language="C#" Value="public class HwndTarget : System.Windows.Media.CompositionTarget" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi HwndTarget extends System.Windows.Media.CompositionTarget" />
<TypeSignature Language="DocId" Value="T:System.Windows.Interop.HwndTarget" />
<TypeSignature Language="VB.NET" Value="Public Class HwndTarget&#xA;Inherits CompositionTarget" />
<TypeSignature Language="C++ CLI" Value="public ref class HwndTarget : System::Windows::Media::CompositionTarget" />
<TypeSignature Language="F#" Value="type HwndTarget = class&#xA; inherit CompositionTarget" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.CompositionTarget</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a binding to a window handle that supports visual composition.</summary>
<remarks>To be added.</remarks>
<threadsafe>A <see cref="T:System.Windows.Interop.HwndTarget" /> is not thread-safe. You can reference a <see cref="T:System.Windows.Interop.HwndTarget" /> only from the thread that created it. If you try to access <see cref="T:System.Windows.Interop.HwndTarget" /> from a different thread, an <see cref="T:System.InvalidOperationException" /> is thrown.</threadsafe>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HwndTarget (IntPtr hwnd);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int hwnd) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Interop.HwndTarget.#ctor(System.IntPtr)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (hwnd As IntPtr)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; HwndTarget(IntPtr hwnd);" />
<MemberSignature Language="F#" Value="new System.Windows.Interop.HwndTarget : nativeint -&gt; System.Windows.Interop.HwndTarget" Usage="new System.Windows.Interop.HwndTarget hwnd" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="hwnd" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="hwnd">The handle for the window that this object draws to.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Interop.HwndTarget" /> class, using the specified HWND.</summary>
<remarks>To be added.</remarks>
<permission cref="T:System.Security.Permissions.UIPermissionWindow">to create an instance. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.AllWindows" />.</permission>
</Docs>
</Member>
<Member MemberName="BackgroundColor">
<MemberSignature Language="C#" Value="public System.Windows.Media.Color BackgroundColor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Media.Color BackgroundColor" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.BackgroundColor" />
<MemberSignature Language="VB.NET" Value="Public Property BackgroundColor As Color" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::Media::Color BackgroundColor { System::Windows::Media::Color get(); void set(System::Windows::Media::Color value); };" />
<MemberSignature Language="F#" Value="member this.BackgroundColor : System.Windows.Media.Color with get, set" Usage="System.Windows.Interop.HwndTarget.BackgroundColor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the background color of the window referenced by this <see cref="T:System.Windows.Interop.HwndTarget" />.</summary>
<value>The background color, as a <see cref="T:System.Windows.Media.Color" /> value.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The background is drawn before any other visual component. The color used must have an alpha component of 1.0. If you attempt to specify a different alpha value in the provided <xref:System.Windows.Media.Color>, it automatically resets to 1.0.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public override void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Interop.HwndTarget.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Dispose ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override void Dispose();" />
<MemberSignature Language="F#" Value="override this.Dispose : unit -&gt; unit" Usage="hwndTarget.Dispose " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases all resources used by the <see cref="T:System.Windows.Interop.HwndTarget" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RenderMode">
<MemberSignature Language="C#" Value="public System.Windows.Interop.RenderMode RenderMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Interop.RenderMode RenderMode" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.RenderMode" />
<MemberSignature Language="VB.NET" Value="Public Property RenderMode As RenderMode" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::Interop::RenderMode RenderMode { System::Windows::Interop::RenderMode get(); void set(System::Windows::Interop::RenderMode value); };" />
<MemberSignature Language="F#" Value="member this.RenderMode : System.Windows.Interop.RenderMode with get, set" Usage="System.Windows.Interop.HwndTarget.RenderMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>set: System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Interop.RenderMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the rendering mode for the window referenced by this <see cref="T:System.Windows.Interop.HwndTarget" />.</summary>
<value>One of the <see cref="T:System.Windows.Interop.RenderMode" /> values that specifies the current render mode. The default is <see cref="F:System.Windows.Interop.RenderMode.Default" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RootVisual">
<MemberSignature Language="C#" Value="public override System.Windows.Media.Visual RootVisual { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.Visual RootVisual" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.RootVisual" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property RootVisual As Visual" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::Visual ^ RootVisual { void set(System::Windows::Media::Visual ^ value); };" />
<MemberSignature Language="F#" Value="member this.RootVisual : System.Windows.Media.Visual" Usage="System.Windows.Interop.HwndTarget.RootVisual" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>set: System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Media.Visual</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the root visual object of the page that is hosted by the window.</summary>
<value>The root visual object of the hosted page.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!IMPORTANT]
> This class only overrides the set{} implementation of this property. Although a get{} implementation exists, it comes from the <xref:System.Windows.Media.CompositionTarget> base class that originally declared this virtual property. On <xref:System.Windows.Interop.HwndTarget> instances, this property is really read-write, despite how the syntax reads in this documentation topic.
]]></format>
</remarks>
<altmember cref="P:System.Windows.Interop.HwndSource.RootVisual" />
<altmember cref="T:System.Windows.Media.CompositionTarget" />
</Docs>
</Member>
<Member MemberName="TransformFromDevice">
<MemberSignature Language="C#" Value="public override System.Windows.Media.Matrix TransformFromDevice { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Media.Matrix TransformFromDevice" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.TransformFromDevice" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property TransformFromDevice As Matrix" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::Matrix TransformFromDevice { System::Windows::Media::Matrix get(); };" />
<MemberSignature Language="F#" Value="member this.TransformFromDevice : System.Windows.Media.Matrix" Usage="System.Windows.Interop.HwndTarget.TransformFromDevice" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Matrix</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a matrix that transforms the coordinates of the device that is associated with the rendering destination of this target.</summary>
<value>The transform matrix.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Matrix" />
<altmember cref="P:System.Windows.Interop.HwndTarget.TransformToDevice" />
<altmember cref="P:System.Windows.Media.CompositionTarget.TransformFromDevice" />
</Docs>
</Member>
<Member MemberName="TransformToDevice">
<MemberSignature Language="C#" Value="public override System.Windows.Media.Matrix TransformToDevice { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Media.Matrix TransformToDevice" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.TransformToDevice" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property TransformToDevice As Matrix" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::Matrix TransformToDevice { System::Windows::Media::Matrix get(); };" />
<MemberSignature Language="F#" Value="member this.TransformToDevice : System.Windows.Media.Matrix" Usage="System.Windows.Interop.HwndTarget.TransformToDevice" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Matrix</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a matrix that transforms the coordinates of this target to the device that is associated with the rendering destination.</summary>
<value>The transform matrix.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Matrix" />
<altmember cref="P:System.Windows.Interop.HwndTarget.TransformFromDevice" />
<altmember cref="P:System.Windows.Media.CompositionTarget.TransformToDevice" />
</Docs>
</Member>
<Member MemberName="UsesPerPixelOpacity">
<MemberSignature Language="C#" Value="public bool UsesPerPixelOpacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UsesPerPixelOpacity" />
<MemberSignature Language="DocId" Value="P:System.Windows.Interop.HwndTarget.UsesPerPixelOpacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UsesPerPixelOpacity As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool UsesPerPixelOpacity { bool get(); };" />
<MemberSignature Language="F#" Value="member this.UsesPerPixelOpacity : bool" Usage="System.Windows.Interop.HwndTarget.UsesPerPixelOpacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5">
<AttributeName>set: System.Security.SecurityCritical</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5">
<AttributeName>set: System.Security.SecurityTreatAsSafe</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that declares whether the per-pixel opacity value of the source window content is used for rendering.</summary>
<value>
<see langword="true" /> if using per-pixel opacity; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If you enable per-pixel opacity, the rendering subsystem no longer draws the non-client area (edge of window).
]]></format>
</remarks>
<altmember cref="P:System.Windows.Interop.HwndSource.UsesPerPixelOpacity" />
<altmember cref="P:System.Windows.Interop.HwndSourceParameters.UsesPerPixelOpacity" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.