/
RecognizeBusinessCardsOptions.xml
148 lines (148 loc) · 8.29 KB
/
RecognizeBusinessCardsOptions.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
<Type Name="RecognizeBusinessCardsOptions" FullName="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions">
<TypeSignature Language="C#" Value="public class RecognizeBusinessCardsOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RecognizeBusinessCardsOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" />
<TypeSignature Language="VB.NET" Value="Public Class RecognizeBusinessCardsOptions" />
<TypeSignature Language="F#" Value="type RecognizeBusinessCardsOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The set of options that can be specified when calling a Recognize Business Cards method
to configure the behavior of the request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RecognizeBusinessCardsOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" /> class which
allows to set options that can be specified when calling a Recognize Business Cards method
to configure the behavior of the request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.FormContentType? ContentType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.AI.FormRecognizer.FormContentType> ContentType" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Property ContentType As Nullable(Of FormContentType)" />
<MemberSignature Language="F#" Value="member this.ContentType : Nullable<Azure.AI.FormRecognizer.FormContentType> with get, set" Usage="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.AI.FormRecognizer.FormContentType></ReturnType>
</ReturnValue>
<Docs>
<summary>
When set, specifies the content type for uploaded streams and skips automatic
content type detection.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IncludeFieldElements">
<MemberSignature Language="C#" Value="public bool IncludeFieldElements { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IncludeFieldElements" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.IncludeFieldElements" />
<MemberSignature Language="VB.NET" Value="Public Property IncludeFieldElements As Boolean" />
<MemberSignature Language="F#" Value="member this.IncludeFieldElements : bool with get, set" Usage="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.IncludeFieldElements" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Whether or not to include all lines per page and field elements such as lines, words,
and selection marks for each form field.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Locale">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.FormRecognizerLocale? Locale { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.AI.FormRecognizer.FormRecognizerLocale> Locale" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.Locale" />
<MemberSignature Language="VB.NET" Value="Public Property Locale As Nullable(Of FormRecognizerLocale)" />
<MemberSignature Language="F#" Value="member this.Locale : Nullable<Azure.AI.FormRecognizer.FormRecognizerLocale> with get, set" Usage="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.Locale" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.AI.FormRecognizer.FormRecognizerLocale></ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets the locale information for the business card.
Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pages">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Pages { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Pages" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.Pages" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Pages As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Pages : System.Collections.Generic.IList<string>" Usage="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions.Pages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>
Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers
and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like
`Pages = { "1-3", "5-6" }`. Separate each page number or range with a comma.
</para>
<para>
Although this collection cannot be set, it can be modified.
See <see href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/object-and-collection-initializers#object-initializers-with-collection-read-only-property-initialization">Object initializers with collection read-only property initialization</see>.
</para>
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>