/
SequentialWorkflowHeaderFooter.xml
269 lines (259 loc) · 20.4 KB
/
SequentialWorkflowHeaderFooter.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<Type Name="SequentialWorkflowHeaderFooter" FullName="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter">
<TypeSignature Language="C#" Value="public class SequentialWorkflowHeaderFooter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SequentialWorkflowHeaderFooter extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" />
<TypeSignature Language="VB.NET" Value="Public Class SequentialWorkflowHeaderFooter" />
<TypeSignature Language="F#" Value="type SequentialWorkflowHeaderFooter = class" />
<TypeSignature Language="C++ CLI" Value="public ref class SequentialWorkflowHeaderFooter" />
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="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;netframework-4.8.1">
<AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a header or footer that is associated with a <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
<xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter> provides header and footer information for the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner> when it is displayed in print preview mode. If provided by the workflow designer, users can configure headers and footers on the **Header/Footer** tab on the **Page Setup** dialog box.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SequentialWorkflowHeaderFooter (System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner parent, bool isHeader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner parent, bool isHeader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.#ctor(System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (parent As SequentialWorkflowRootDesigner, isHeader As Boolean)" />
<MemberSignature Language="F#" Value="new System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter : System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner * bool -> System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" Usage="new System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter (parent, isHeader)" />
<MemberSignature Language="C++ CLI" Value="public:
 SequentialWorkflowHeaderFooter(System::Workflow::ComponentModel::Design::SequentialWorkflowRootDesigner ^ parent, bool isHeader);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="parent" Type="System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner" />
<Parameter Name="isHeader" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="parent">The <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner" /> to associate the header or footer with.</param>
<param name="isHeader">
<see langword="true" /> to indicate that the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> is a header; <see langword="false" /> to indicate that the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> is a footer.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AssociatedDesigner">
<MemberSignature Language="C#" Value="protected System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner AssociatedDesigner { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner AssociatedDesigner" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.AssociatedDesigner" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property AssociatedDesigner As SequentialWorkflowRootDesigner" />
<MemberSignature Language="F#" Value="member this.AssociatedDesigner : System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.AssociatedDesigner" />
<MemberSignature Language="C++ CLI" Value="protected:
 property System::Workflow::ComponentModel::Design::SequentialWorkflowRootDesigner ^ AssociatedDesigner { System::Workflow::ComponentModel::Design::SequentialWorkflowRootDesigner ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the root designer to which the header or footer is applied.</summary>
<value>The <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowRootDesigner" /> to which the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> is applied.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Bounds">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Rectangle Bounds { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Drawing.Rectangle Bounds" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Bounds" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Bounds As Rectangle" />
<MemberSignature Language="F#" Value="member this.Bounds : System.Drawing.Rectangle" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Bounds" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Rectangle Bounds { System::Drawing::Rectangle get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Rectangle</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the bounding rectangle of the header or footer on the workflow design surface.</summary>
<value>The <see cref="T:System.Drawing.Rectangle" /> that bounds the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> on the workflow design surface.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Image">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Image Image { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Drawing.Image Image" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Image" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Image As Image" />
<MemberSignature Language="F#" Value="member this.Image : System.Drawing.Image with get, set" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Image" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Image ^ Image { System::Drawing::Image ^ get(); void set(System::Drawing::Image ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Image</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the image associated with the header or footer.</summary>
<value>The <see cref="T:System.Drawing.Image" /> to associate with the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ImageRectangle">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Rectangle ImageRectangle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Drawing.Rectangle ImageRectangle" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.ImageRectangle" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ImageRectangle As Rectangle" />
<MemberSignature Language="F#" Value="member this.ImageRectangle : System.Drawing.Rectangle" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.ImageRectangle" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Rectangle ImageRectangle { System::Drawing::Rectangle get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Rectangle</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the bounding rectangle for the image associated with the header or footer.</summary>
<value>The <see cref="T:System.Drawing.Rectangle" /> that defines the bounds for the <see cref="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Image" /> associated with the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to override the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.ImageRectangle%2A> property. In this example, the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.ImageRectangle%2A> is calculated using the Bounds of the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter> to draw the image in the upper left corner of the header/footer.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet74":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet74":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnLayout">
<MemberSignature Language="C#" Value="public virtual void OnLayout (System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnLayout(class System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.OnLayout(System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub OnLayout (e As ActivityDesignerLayoutEventArgs)" />
<MemberSignature Language="F#" Value="abstract member OnLayout : System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs -> unit
override this.OnLayout : System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs -> unit" Usage="sequentialWorkflowHeaderFooter.OnLayout e" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void OnLayout(System::Workflow::ComponentModel::Design::ActivityDesignerLayoutEventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs" />
</Parameters>
<Docs>
<param name="e">An <see cref="T:System.Workflow.ComponentModel.Design.ActivityDesignerLayoutEventArgs" /> that contains the event data.</param>
<summary>Notifies the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" /> when the elements it contains are repositioned by the user.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnPaint">
<MemberSignature Language="C#" Value="public virtual void OnPaint (System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnPaint(class System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.OnPaint(System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub OnPaint (e As ActivityDesignerPaintEventArgs)" />
<MemberSignature Language="F#" Value="abstract member OnPaint : System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs -> unit
override this.OnPaint : System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs -> unit" Usage="sequentialWorkflowHeaderFooter.OnPaint e" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void OnPaint(System::Workflow::ComponentModel::Design::ActivityDesignerPaintEventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs" />
</Parameters>
<Docs>
<param name="e">An <see cref="T:System.Workflow.ComponentModel.Design.ActivityDesignerPaintEventArgs" /> that contains the event data.</param>
<summary>Draws the header or footer associated with the workflow root designer on the design surface.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="e" /> contains a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public virtual string Text { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Text" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string with get, set" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Text" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the text description associated with the header or footer.</summary>
<value>The string that contains the text description associated with the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TextRectangle">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Rectangle TextRectangle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Drawing.Rectangle TextRectangle" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.TextRectangle" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property TextRectangle As Rectangle" />
<MemberSignature Language="F#" Value="member this.TextRectangle : System.Drawing.Rectangle" Usage="System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.TextRectangle" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Rectangle TextRectangle { System::Drawing::Rectangle get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Rectangle</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the bounding rectangle for the text associated with the header or footer.</summary>
<value>The <see cref="T:System.Drawing.Rectangle" /> that defines the bounds for the <see cref="P:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.Text" /> associated with the <see cref="T:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to override the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.TextRectangle%2A> property. In this example, the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.TextRectangle%2A> is calculated using the Bounds of the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter> as well as the location and size of the <xref:System.Workflow.ComponentModel.Design.SequentialWorkflowHeaderFooter.ImageRectangle%2A>.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet75":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet75":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>