markus / TEST_WPF / bin / Debug / Leadtools.Documents.xml @ 9322ec12
이력 | 보기 | 이력해설 | 다운로드 (91.1 KB)
1 | 787a4489 | KangIngu | <?xml version="1.0" encoding="utf-8"?>
|
---|---|---|---|
2 | <doc>
|
||
3 | <assembly>
|
||
4 | <name>Leadtools.Documents</name> |
||
5 | </assembly>
|
||
6 | <members>
|
||
7 | <member name="T:Leadtools.Documents.Constants"> |
||
8 | <summary>Contains constant values used by this framework.</summary> |
||
9 | </member>
|
||
10 | <member name="F:Leadtools.Documents.Constants.ABCMimeType"> |
||
11 | <summary>ABC MIME type</summary> |
||
12 | </member>
|
||
13 | <member name="F:Leadtools.Documents.Constants.ABICMimeType"> |
||
14 | <summary>ABIC MIME type</summary> |
||
15 | </member>
|
||
16 | <member name="F:Leadtools.Documents.Constants.BMPMimeType"> |
||
17 | <summary>BMP MIME type</summary> |
||
18 | </member>
|
||
19 | <member name="F:Leadtools.Documents.Constants.CALSMimeType"> |
||
20 | <summary>CALS MIME type</summary> |
||
21 | </member>
|
||
22 | <member name="F:Leadtools.Documents.Constants.CMPMimeType"> |
||
23 | <summary>LEAD CMP MIME type</summary> |
||
24 | </member>
|
||
25 | <member name="F:Leadtools.Documents.Constants.CMWMimeType"> |
||
26 | <summary>CMW MIME type</summary> |
||
27 | </member>
|
||
28 | <member name="F:Leadtools.Documents.Constants.DCRMimeType"> |
||
29 | <summary>DCR MIME type</summary> |
||
30 | </member>
|
||
31 | <member name="F:Leadtools.Documents.Constants.DCSMimeType"> |
||
32 | <summary>DCS MIME type</summary> |
||
33 | </member>
|
||
34 | <member name="F:Leadtools.Documents.Constants.DefaultMimeType"> |
||
35 | <summary>Default binary MIME type</summary> |
||
36 | </member>
|
||
37 | <member name="F:Leadtools.Documents.Constants.DICOMMimeType"> |
||
38 | <summary>DICOM MIME type</summary> |
||
39 | </member>
|
||
40 | <member name="F:Leadtools.Documents.Constants.DOCMimeType"> |
||
41 | <summary>DOC MIME type</summary> |
||
42 | </member>
|
||
43 | <member name="F:Leadtools.Documents.Constants.DOCXMimeType"> |
||
44 | <summary>DOCX MIME type</summary> |
||
45 | </member>
|
||
46 | <member name="F:Leadtools.Documents.Constants.ECWMimeType"> |
||
47 | <summary>ECW MIME type</summary> |
||
48 | </member>
|
||
49 | <member name="F:Leadtools.Documents.Constants.FAXMimeType"> |
||
50 | <summary>FAX MIME type</summary> |
||
51 | </member>
|
||
52 | <member name="F:Leadtools.Documents.Constants.FPXMimeType"> |
||
53 | <summary>FPX MIME type</summary> |
||
54 | </member>
|
||
55 | <member name="F:Leadtools.Documents.Constants.GIFMimeType"> |
||
56 | <summary>GIF MIME type</summary> |
||
57 | </member>
|
||
58 | <member name="F:Leadtools.Documents.Constants.IFFMimeType"> |
||
59 | <summary>IFF MIME type</summary> |
||
60 | </member>
|
||
61 | <member name="F:Leadtools.Documents.Constants.IOCAMimeType"> |
||
62 | <summary>IOCA MIME type</summary> |
||
63 | </member>
|
||
64 | <member name="F:Leadtools.Documents.Constants.J2KMimeType"> |
||
65 | <summary>J2K MIME type</summary> |
||
66 | </member>
|
||
67 | <member name="F:Leadtools.Documents.Constants.JBIG2MimeType"> |
||
68 | <summary>JBIG 2 MIME type</summary> |
||
69 | </member>
|
||
70 | <member name="F:Leadtools.Documents.Constants.JBIGMimeType"> |
||
71 | <summary>JBIG MIME type</summary> |
||
72 | </member>
|
||
73 | <member name="F:Leadtools.Documents.Constants.JPEGMimeType"> |
||
74 | <summary>JPEG MIME type</summary> |
||
75 | </member>
|
||
76 | <member name="F:Leadtools.Documents.Constants.JXRMimeType"> |
||
77 | <summary>JXR MIME type</summary> |
||
78 | </member>
|
||
79 | <member name="F:Leadtools.Documents.Constants.KDCMimeType"> |
||
80 | <summary>KDC MIME type</summary> |
||
81 | </member>
|
||
82 | <member name="F:Leadtools.Documents.Constants.LEADMRCMimeType"> |
||
83 | <summary>LEAD MRC MIME type</summary> |
||
84 | </member>
|
||
85 | <member name="F:Leadtools.Documents.Constants.MetafileMimeType"> |
||
86 | <summary>WMF/EMF MIME type</summary> |
||
87 | </member>
|
||
88 | <member name="F:Leadtools.Documents.Constants.MRCMimeType"> |
||
89 | <summary>MRC MIME type</summary> |
||
90 | </member>
|
||
91 | <member name="F:Leadtools.Documents.Constants.PBMMimeType"> |
||
92 | <summary>PBM MIME type</summary> |
||
93 | </member>
|
||
94 | <member name="F:Leadtools.Documents.Constants.PCXMimeType"> |
||
95 | <summary>PCX MIME type</summary> |
||
96 | </member>
|
||
97 | <member name="F:Leadtools.Documents.Constants.PDFMimeType"> |
||
98 | <summary>PDF MIME type</summary> |
||
99 | </member>
|
||
100 | <member name="F:Leadtools.Documents.Constants.PGMMimeType"> |
||
101 | <summary>PGM MIME type</summary> |
||
102 | </member>
|
||
103 | <member name="F:Leadtools.Documents.Constants.PNGMimeType"> |
||
104 | <summary>PNG MIME type</summary> |
||
105 | </member>
|
||
106 | <member name="F:Leadtools.Documents.Constants.PostscriptMimeType"> |
||
107 | <summary>Postscrtpt MIME type</summary> |
||
108 | </member>
|
||
109 | <member name="F:Leadtools.Documents.Constants.PPMMimeType"> |
||
110 | <summary>PPM MIME type</summary> |
||
111 | </member>
|
||
112 | <member name="F:Leadtools.Documents.Constants.PPTMimeType"> |
||
113 | <summary>PPT MIME type</summary> |
||
114 | </member>
|
||
115 | <member name="F:Leadtools.Documents.Constants.PPTXMimeType"> |
||
116 | <summary>PPTX MIME type</summary> |
||
117 | </member>
|
||
118 | <member name="F:Leadtools.Documents.Constants.PSDMimeType"> |
||
119 | <summary>PCD MIME type</summary> |
||
120 | </member>
|
||
121 | <member name="F:Leadtools.Documents.Constants.RASMimeType"> |
||
122 | <summary>Sun Raster MIME type</summary> |
||
123 | </member>
|
||
124 | <member name="F:Leadtools.Documents.Constants.RAWMimeType"> |
||
125 | <summary>RAW MIME type</summary> |
||
126 | </member>
|
||
127 | <member name="F:Leadtools.Documents.Constants.RTFMimeType"> |
||
128 | <summary>RTF MIME type</summary> |
||
129 | </member>
|
||
130 | <member name="F:Leadtools.Documents.Constants.SCTMimeType"> |
||
131 | <summary>SCT MIME type</summary> |
||
132 | </member>
|
||
133 | <member name="F:Leadtools.Documents.Constants.SGIMimeType"> |
||
134 | <summary>SGI MIME type</summary> |
||
135 | </member>
|
||
136 | <member name="F:Leadtools.Documents.Constants.SMPMimeType"> |
||
137 | <summary>SMP MIME type</summary> |
||
138 | </member>
|
||
139 | <member name="F:Leadtools.Documents.Constants.TGAMimeType"> |
||
140 | <summary>TGA MIME type</summary> |
||
141 | </member>
|
||
142 | <member name="F:Leadtools.Documents.Constants.TIFMimeType"> |
||
143 | <summary>TIFF MIME type</summary> |
||
144 | </member>
|
||
145 | <member name="F:Leadtools.Documents.Constants.TXTMimeType"> |
||
146 | <summary>TXT MIME type</summary> |
||
147 | </member>
|
||
148 | <member name="F:Leadtools.Documents.Constants.WBMPMimeType"> |
||
149 | <summary>WBMP MIME type</summary> |
||
150 | </member>
|
||
151 | <member name="F:Leadtools.Documents.Constants.WinCursorMimeType"> |
||
152 | <summary>Windows Cursor MIME type</summary> |
||
153 | </member>
|
||
154 | <member name="F:Leadtools.Documents.Constants.WinIconMimeType"> |
||
155 | <summary>Windows Icon MIME type</summary> |
||
156 | </member>
|
||
157 | <member name="F:Leadtools.Documents.Constants.XBMMimeType"> |
||
158 | <summary>XBM MIME type</summary> |
||
159 | </member>
|
||
160 | <member name="F:Leadtools.Documents.Constants.XLSMimeType"> |
||
161 | <summary>XLS MIME type</summary> |
||
162 | </member>
|
||
163 | <member name="F:Leadtools.Documents.Constants.XLSXMimeType"> |
||
164 | <summary>XLSX MIME type</summary> |
||
165 | </member>
|
||
166 | <member name="F:Leadtools.Documents.Constants.XPMMimeType"> |
||
167 | <summary>XPM MIME type</summary> |
||
168 | </member>
|
||
169 | <member name="F:Leadtools.Documents.Constants.XPSMimeType"> |
||
170 | <summary>XPS MIME type</summary> |
||
171 | </member>
|
||
172 | <member name="F:Leadtools.Documents.Constants.XWDMimeType"> |
||
173 | <summary>XWD MIME type</summary> |
||
174 | </member>
|
||
175 | <member name="T:Leadtools.Documents.CreateDocumentOptions"> |
||
176 | <summary>Options to use when creating a new document.</summary> |
||
177 | </member>
|
||
178 | <member name="M:Leadtools.Documents.CreateDocumentOptions.#ctor"> |
||
179 | <summary>Initializes a new instance of CreateDocumentOptions with default parameters.</summary> |
||
180 | </member>
|
||
181 | <member name="P:Leadtools.Documents.CreateDocumentOptions.Cache"> |
||
182 | <summary>The cache to use with the new document.</summary> |
||
183 | <value>The cache to use with the new document. Default value is **null**.</value> |
||
184 | </member>
|
||
185 | <member name="P:Leadtools.Documents.CreateDocumentOptions.CachePolicy"> |
||
186 | <summary>The cache policy to use with the new document.</summary> |
||
187 | <value>The cache policy to use for the new document that determine when the document and its parts are purged. Default value is</value> |
||
188 | </member>
|
||
189 | <member name="P:Leadtools.Documents.CreateDocumentOptions.Descriptor"> |
||
190 | <summary>The JSON serializable object that describes a document.</summary> |
||
191 | <value>JSON serializable object that describes a document.</value> |
||
192 | </member>
|
||
193 | <member name="P:Leadtools.Documents.CreateDocumentOptions.DocumentId"> |
||
194 | <summary>The ID to be used with the loaded document.</summary> |
||
195 | <value>String that specifies the ID to be used with the loaded document. Default value is **null**.</value> |
||
196 | </member>
|
||
197 | <member name="P:Leadtools.Documents.CreateDocumentOptions.MimeType"> |
||
198 | <summary>MIME type of the new document.</summary> |
||
199 | <value>The MIME type of the new document. Default value is **null**.</value> |
||
200 | </member>
|
||
201 | <member name="P:Leadtools.Documents.CreateDocumentOptions.UseCache"> |
||
202 | <summary>Indicates whether the new document will use the cache system.</summary> |
||
203 | <value>**true** if the new document will use the cache system, otherwise; **false**. Default value is **false**.</value> |
||
204 | </member>
|
||
205 | <member name="T:Leadtools.Documents.Document"> |
||
206 | <summary>Encapsulates a multi-page document with support for raster and SVG images, bookmarks, annotations and text data.</summary> |
||
207 | </member>
|
||
208 | <member name="M:Leadtools.Documents.Document.#ctor"> |
||
209 | <summary>Initializes a new instance of Document.</summary> |
||
210 | </member>
|
||
211 | <member name="M:Leadtools.Documents.Document.CreateCacheItemPolicy"> |
||
212 | <summary>Create a new policy to be used when items of this document is cached.</summary> |
||
213 | <returns>The new cache policy.</returns> |
||
214 | </member>
|
||
215 | <member name="M:Leadtools.Documents.Document.CreateDocumentDescriptor"> |
||
216 | <summary>Creates a descritpor object that can be used to re-create this document.</summary> |
||
217 | <returns>Object containing the values required to re-create this document.</returns> |
||
218 | </member>
|
||
219 | <member name="M:Leadtools.Documents.Document.Decrypt(System.String)"> |
||
220 | <summary>Decrypt this document using the specified password.</summary> |
||
221 | <param name="password">String containing the password phrase to decrypt this document.</param> |
||
222 | </member>
|
||
223 | <member name="M:Leadtools.Documents.Document.Dispose"> |
||
224 | <summary>Releases all resources used by this Document.</summary> |
||
225 | </member>
|
||
226 | <member name="M:Leadtools.Documents.Document.Dispose"> |
||
227 | <summary>Releases all resources used by this Document.</summary> |
||
228 | <param name="disposing"></param> |
||
229 | </member>
|
||
230 | <member name="M:Leadtools.Documents.Document.DocumentToPixels(System.Double,System.Double)"> |
||
231 | <summary>Converts a value from document units to pixels.</summary> |
||
232 | <param name="resolution">The resolution to use.</param> |
||
233 | <param name="value">Source value to convert in document units.</param> |
||
234 | <returns>The converted value in pixels.</returns> |
||
235 | </member>
|
||
236 | <member name="M:Leadtools.Documents.Document.GetAnnotationsFileName"> |
||
237 | <summary>Path to the file holding the original annotations.</summary> |
||
238 | <returns>The path to the file holding the original annotations.</returns> |
||
239 | </member>
|
||
240 | <member name="M:Leadtools.Documents.Document.GetAnnotationsStream"> |
||
241 | <summary>Stream containing the data of the original annotations.</summary> |
||
242 | <returns>Stream containing the data of the original annotations.</returns> |
||
243 | </member>
|
||
244 | <member name="M:Leadtools.Documents.Document.GetCache"> |
||
245 | <summary>Gets the cache object used with by this document.</summary> |
||
246 | <returns>The cache object used with by this document.</returns> |
||
247 | </member>
|
||
248 | <member name="M:Leadtools.Documents.Document.GetCacheKeys"> |
||
249 | <summary>Get the cache keys used by this document.</summary> |
||
250 | <returns>Set of all possible cache keys used by this document.</returns> |
||
251 | </member>
|
||
252 | <member name="M:Leadtools.Documents.Document.GetDocumentFileName"> |
||
253 | <summary>Path to the file holding the original document.</summary> |
||
254 | <returns>The path to the file holding the original document.</returns> |
||
255 | </member>
|
||
256 | <member name="M:Leadtools.Documents.Document.GetDocumentStream"> |
||
257 | <summary>Stream containing the data of the original document.</summary> |
||
258 | <returns>Stream containing the data of the original document.</returns> |
||
259 | </member>
|
||
260 | <member name="M:Leadtools.Documents.Document.LockStreams"> |
||
261 | <summary>Lock the document and annotation streams to be used by the current thread only.</summary> |
||
262 | </member>
|
||
263 | <member name="M:Leadtools.Documents.Document.PixelsToDocument(System.Double,System.Int32)"> |
||
264 | <summary>Converts a value from pixels to document units.</summary> |
||
265 | <param name="resolution">The resolution to use.</param> |
||
266 | <param name="value">Source value to convert in pixels.</param> |
||
267 | <returns>The converted value in document units.</returns> |
||
268 | </member>
|
||
269 | <member name="M:Leadtools.Documents.Document.PointToDocument(Leadtools.LeadPoint)"> |
||
270 | <summary>Converts a point from pixels to document units.</summary> |
||
271 | <param name="value">Source value in pixels.</param> |
||
272 | <returns>The converted value in document units.</returns> |
||
273 | </member>
|
||
274 | <member name="M:Leadtools.Documents.Document.PointToPixels(Leadtools.LeadPointD)"> |
||
275 | <summary>Converts a point from document units to pixels.</summary> |
||
276 | <param name="value">Source value in document units.</param> |
||
277 | <returns>The converted value in pixels.</returns> |
||
278 | </member>
|
||
279 | <member name="M:Leadtools.Documents.Document.RectToDocument(Leadtools.LeadRect)"> |
||
280 | <summary>Converts a rectangle from pixels to document units.</summary> |
||
281 | <param name="value">Source value in pixels.</param> |
||
282 | <returns>The converted value in document units.</returns> |
||
283 | </member>
|
||
284 | <member name="M:Leadtools.Documents.Document.RectToPixels(Leadtools.LeadRectD)"> |
||
285 | <summary>Converts a rectangle from document units to pixels.</summary> |
||
286 | <param name="value">Source value in document units.</param> |
||
287 | <returns>The converted value in pixels.</returns> |
||
288 | </member>
|
||
289 | <member name="M:Leadtools.Documents.Document.SaveToCache"> |
||
290 | <summary>Saves the document to the cache.</summary> |
||
291 | </member>
|
||
292 | <member name="M:Leadtools.Documents.Document.SaveToFile(System.String,Leadtools.Documents.SaveDocumentOptions)"> |
||
293 | <summary>Exports this document to the specified file using the specified format.</summary> |
||
294 | <param name="fileName">Target file name. This cannot be **null**.</param> |
||
295 | <param name="options">Options to use when saving the document. If this is **null**, then the document will be saved</param> |
||
296 | </member>
|
||
297 | <member name="M:Leadtools.Documents.Document.SaveToUri(System.Uri,Leadtools.Documents.SaveDocumentOptions)"> |
||
298 | <summary>Exports this document to the specified remote URL using the specified format.</summary> |
||
299 | <param name="uri">Target URL. This cannot be **null**.</param> |
||
300 | <param name="options">Options to use when saving the document. If this is **null**, then the document will be saved</param> |
||
301 | </member>
|
||
302 | <member name="M:Leadtools.Documents.Document.SizeToDocument(Leadtools.LeadSize)"> |
||
303 | <summary>Converts a size from pixels to document units.</summary> |
||
304 | <param name="value">Source value in pixels.</param> |
||
305 | <returns>The converted value in document units.</returns> |
||
306 | </member>
|
||
307 | <member name="M:Leadtools.Documents.Document.SizeToPixels(Leadtools.LeadSizeD)"> |
||
308 | <summary>Converts a size from document units to pixels.</summary> |
||
309 | <param name="value">Source value in document units.</param> |
||
310 | <returns>The converted value in pixels.</returns> |
||
311 | </member>
|
||
312 | <member name="M:Leadtools.Documents.Document.UnlockStreams"> |
||
313 | <summary>Unlock the document and annotation streams from the current thread.</summary> |
||
314 | </member>
|
||
315 | <member name="M:Leadtools.Documents.Document.UpdateFromDocumentDescriptor(Leadtools.Documents.DocumentDescriptor)"> |
||
316 | <summary>Update this document from a descriptor.</summary> |
||
317 | <param name="descriptor">Simple JSON object that contains properties of the document.</param> |
||
318 | </member>
|
||
319 | <member name="M:Leadtools.Documents.Document.Finalize"> |
||
320 | <summary>This method overrides System.Object.Finalize</summary> |
||
321 | </member>
|
||
322 | <member name="P:Leadtools.Documents.Document.Annotations"> |
||
323 | <summary>Object that manages the annotations of the document.</summary> |
||
324 | <value>The DocumentAnnotations object that manages the annotations of this Document.</value> |
||
325 | </member>
|
||
326 | <member name="P:Leadtools.Documents.Document.AutoDeleteFromCache"> |
||
327 | <summary>Indicates whether to delete all the entries that belong to this document from the cache when it is disposed.</summary> |
||
328 | <value>**true** to delete all the entries that belong to this document from the cache when it is disposed, otherwise; **false**.</value> |
||
329 | </member>
|
||
330 | <member name="P:Leadtools.Documents.Document.AutoDisposeDocuments"> |
||
331 | <summary>Indicates whether to automatically dispose any child documents.</summary> |
||
332 | <value>**true** to automatically dispose any child documents when this document is disposed, otherwise; **false**.</value> |
||
333 | </member>
|
||
334 | <member name="P:Leadtools.Documents.Document.AutoSaveToCache"> |
||
335 | <summary>Indicates whether to automatically save the document to the cache before it is disposed.</summary> |
||
336 | <value>**true** to automatically save the document to the cache before it is disposed, otherwise; **false**.</value> |
||
337 | </member>
|
||
338 | <member name="P:Leadtools.Documents.Document.Barcodes"> |
||
339 | <summary>Object that manages the barcodes of the document.</summary> |
||
340 | <value>The DocumentBarcodes object that manages the barcodes of this Document.</value> |
||
341 | </member>
|
||
342 | <member name="P:Leadtools.Documents.Document.CacheOptions"> |
||
343 | <summary>Determines which part of the document will be stored in the cache.</summary> |
||
344 | <value>Determines which part of the document will be stored in the cache. Default value is DocumentCacheOptions.None.</value> |
||
345 | </member>
|
||
346 | <member name="P:Leadtools.Documents.Document.CacheStatus"> |
||
347 | <summary>The cache status of this document.</summary> |
||
348 | <value>The cache status of this document. Default value is DocumentCacheStatus.NotSynced.</value> |
||
349 | </member>
|
||
350 | <member name="P:Leadtools.Documents.Document.CacheUri"> |
||
351 | <summary>The URL to the original document's image data if it was stored in the cache.</summary> |
||
352 | <value>The URL to the original document's image data if it was stored in the cache; otherwise, **null**.</value> |
||
353 | </member>
|
||
354 | <member name="P:Leadtools.Documents.Document.DocumentId"> |
||
355 | <summary>Unique identifier of this document.</summary> |
||
356 | <value>The unique identifier of this document.</value> |
||
357 | </member>
|
||
358 | <member name="P:Leadtools.Documents.Document.Documents"> |
||
359 | <summary>Object that manages the children of this document.</summary> |
||
360 | <value>The DocumentDocuments object that manages the children of this Document.</value> |
||
361 | </member>
|
||
362 | <member name="P:Leadtools.Documents.Document.DocumentType"> |
||
363 | <summary>Document type.</summary> |
||
364 | <value>The document type.</value> |
||
365 | </member>
|
||
366 | <member name="P:Leadtools.Documents.Document.FileLength"> |
||
367 | <summary>Length of the original document file or URL.</summary> |
||
368 | <value>The length of the original document file or URL in bytes.</value> |
||
369 | </member>
|
||
370 | <member name="P:Leadtools.Documents.Document.Format"> |
||
371 | <summary>Gets the LEADTOOLS raster image format identifier for this document.</summary> |
||
372 | <value>The LEADTOOLS raster image format identifier for this document.</value> |
||
373 | </member>
|
||
374 | <member name="P:Leadtools.Documents.Document.HasAnnotationsStream"> |
||
375 | <summary>Indicates that the document has a valid stream containing the data of the original annotations.</summary> |
||
376 | <value>**true** if the document has a valid stream containing the data of the original annotations; otherwise; **false**.</value> |
||
377 | </member>
|
||
378 | <member name="P:Leadtools.Documents.Document.HasCache"> |
||
379 | <summary>Indicates whether this Document is using the cache.</summary> |
||
380 | <value>**true** if this document uses the cache system, otherwise; **false**.</value> |
||
381 | </member>
|
||
382 | <member name="P:Leadtools.Documents.Document.HasDocuments"> |
||
383 | <summary>Determine whether this document has children.</summary> |
||
384 | <value>**true** if this document has children; otherwise, **false**.</value> |
||
385 | </member>
|
||
386 | <member name="P:Leadtools.Documents.Document.HasStream"> |
||
387 | <summary>Indicates that the document has a valid stream containing the data of the original document.</summary> |
||
388 | <value>**true** if the document has a valid stream containing the data of the original document; otherwise; **false**.</value> |
||
389 | </member>
|
||
390 | <member name="P:Leadtools.Documents.Document.Images"> |
||
391 | <summary>Object that manages the raster and SVG image settings of the document.</summary> |
||
392 | <value>The DocumentImages object that manages the raster and SVG image settings of this Document.</value> |
||
393 | </member>
|
||
394 | <member name="P:Leadtools.Documents.Document.InternalObject"> |
||
395 | <summary>Internal LEADTOOLS object used with the document.</summary> |
||
396 | <value>The internal LEADTOOLS object used with the document.</value> |
||
397 | </member>
|
||
398 | <member name="P:Leadtools.Documents.Document.IsDecrypted"> |
||
399 | <summary>Indicates whether this document has been decrypted.</summary> |
||
400 | <value>**true** if this document has been decrypted, otherwise; **false**.</value> |
||
401 | </member>
|
||
402 | <member name="P:Leadtools.Documents.Document.IsDownloaded"> |
||
403 | <summary>Indicates if this document was downloaded.</summary> |
||
404 | <value>**true** if this document was downloaded, otherwise; **false**.</value> |
||
405 | </member>
|
||
406 | <member name="P:Leadtools.Documents.Document.IsEncrypted"> |
||
407 | <summary>Indicates whether this document is encrypted.</summary> |
||
408 | <value>**true** if this document is encrypted, otherwise; **false**.</value> |
||
409 | </member>
|
||
410 | <member name="P:Leadtools.Documents.Document.IsLocal"> |
||
411 | <summary>Indicate that this document has been created by the user.</summary> |
||
412 | <value>**true** if this document has been created by the user; otherwise, **false**.</value> |
||
413 | </member>
|
||
414 | <member name="P:Leadtools.Documents.Document.IsReadOnly"> |
||
415 | <summary>Indicates that this document is read-only and cannot be modified.</summary> |
||
416 | <value>**true** if this document is read-only and cannot be modified, otherwise; **false**. Default value is **false**.</value> |
||
417 | </member>
|
||
418 | <member name="P:Leadtools.Documents.Document.IsStructureSupported"> |
||
419 | <summary>Determines if the document structure is supported.</summary> |
||
420 | <value>**true** if the document structure is supported, otherwise; **false**.</value> |
||
421 | </member>
|
||
422 | <member name="P:Leadtools.Documents.Document.LastCacheSyncTime"> |
||
423 | <summary>Timestamp of when the document was last saved to the cache sucessfully.</summary> |
||
424 | <value>Timestamp of when the document was last saved to the cache sucessfully.</value> |
||
425 | </member>
|
||
426 | <member name="P:Leadtools.Documents.Document.Metadata"> |
||
427 | <summary>Object that manages the metadata of the document.</summary> |
||
428 | <value>The DocumentMetadata object that manages the metadata of this Document.</value> |
||
429 | </member>
|
||
430 | <member name="P:Leadtools.Documents.Document.MimeType"> |
||
431 | <summary>MIME type of the document.</summary> |
||
432 | <value>The MIME type of the document.</value> |
||
433 | </member>
|
||
434 | <member name="P:Leadtools.Documents.Document.Name"> |
||
435 | <summary>Name of the document.</summary> |
||
436 | <value>The name of the document.</value> |
||
437 | </member>
|
||
438 | <member name="P:Leadtools.Documents.Document.Pages"> |
||
439 | <summary>Object that manages the pages of the document.</summary> |
||
440 | <value>The DocumentPages object that manages the pages of this Document.</value> |
||
441 | </member>
|
||
442 | <member name="P:Leadtools.Documents.Document.RasterCodecs"> |
||
443 | <summary>Object that is used to load or save raster images and SVG documents.</summary> |
||
444 | <value>The RasterCodecs object to use when this Document loads or saves RasterImage and SvgDocument</value> |
||
445 | </member>
|
||
446 | <member name="P:Leadtools.Documents.Document.Stream"> |
||
447 | <summary>Original document stream.</summary> |
||
448 | <value>Original document stream.</value> |
||
449 | </member>
|
||
450 | <member name="P:Leadtools.Documents.Document.Structure"> |
||
451 | <summary>Object that manages the structure and table of content of the document.</summary> |
||
452 | <value>The DocumentStructure object that manages the structure and table of content of this Document.</value> |
||
453 | </member>
|
||
454 | <member name="P:Leadtools.Documents.Document.Text"> |
||
455 | <summary>Object that manages the text and OCR recognition settings of the document.</summary> |
||
456 | <value>The DocumentText object that manages the text and OCR recognition settings of this Document.</value> |
||
457 | </member>
|
||
458 | <member name="P:Leadtools.Documents.Document.Uri"> |
||
459 | <summary>URL to the original document physical location.</summary> |
||
460 | <value>The URL to the original document physical location.</value> |
||
461 | </member>
|
||
462 | <member name="P:Leadtools.Documents.Document.UserData"> |
||
463 | <summary>The user-defined data associated with this document.</summary> |
||
464 | <value>Any object that can be used as the user-defined data associated with this document. Default value is **null**.</value> |
||
465 | </member>
|
||
466 | <member name="F:Leadtools.Documents.Document.UnitsPerInch"> |
||
467 | <summary>Number of units per inch used for document coordinates.</summary> |
||
468 | </member>
|
||
469 | <member name="T:Leadtools.Documents.DocumentAnnotations"> |
||
470 | <summary>Manages the global annotations settings for the document.</summary> |
||
471 | </member>
|
||
472 | <member name="M:Leadtools.Documents.DocumentAnnotations.GetAnnotations(System.Boolean)"> |
||
473 | <summary>Gets an array of annotations container objects for all pages with a single call.</summary> |
||
474 | <param name="createEmpty"></param> |
||
475 | <returns>An array of AnnContainer for each page. The array can contain any number of containers and in any order. The user must</returns> |
||
476 | </member>
|
||
477 | <member name="M:Leadtools.Documents.DocumentAnnotations.SetAnnotations(Leadtools.Annotations.Core.AnnContainer)"> |
||
478 | <summary>Updates the annotations container objects for one or more pages with a single call.</summary> |
||
479 | <param name="containers">An array of AnnContainer objects to update. The user must set the</param> |
||
480 | </member>
|
||
481 | <member name="P:Leadtools.Documents.DocumentAnnotations.AnnotationsUri"> |
||
482 | <summary>Location of the external annotation file used when this document was loaded.</summary> |
||
483 | <value>The location of the external annotation file used when this document was loaded.</value> |
||
484 | </member>
|
||
485 | <member name="P:Leadtools.Documents.DocumentAnnotations.Document"> |
||
486 | <summary>Owner document of this DocumentAnnotations</summary> |
||
487 | <value>The owner Document object of this DocumentAnnotations.</value> |
||
488 | </member>
|
||
489 | <member name="T:Leadtools.Documents.DocumentBarcodes"> |
||
490 | <summary>Manages the global barcodes settings for the document.</summary> |
||
491 | </member>
|
||
492 | <member name="P:Leadtools.Documents.DocumentBarcodes.BarcodeEngine"> |
||
493 | <summary>Engine instance to use when reading barcodes.</summary> |
||
494 | <value>The engine instance to use when reading barcodes. Default value is **null**.</value> |
||
495 | </member>
|
||
496 | <member name="P:Leadtools.Documents.DocumentBarcodes.Document"> |
||
497 | <summary>Owner document of this DocumentBarcodes</summary> |
||
498 | <value>The owner Document object of this DocumentBarcodes.</value> |
||
499 | </member>
|
||
500 | <member name="T:Leadtools.Documents.DocumentBookmark"> |
||
501 | <summary>Represents a document bookmark (table of content) item.</summary> |
||
502 | </member>
|
||
503 | <member name="M:Leadtools.Documents.DocumentBookmark.Clone(System.Boolean)"> |
||
504 | <summary>Returns an extact clone of this object.</summary> |
||
505 | <param name="withChildren"></param> |
||
506 | <returns>Extact clone of this object.</returns> |
||
507 | </member>
|
||
508 | <member name="P:Leadtools.Documents.DocumentBookmark.Children"> |
||
509 | <summary>Child bookmarks.</summary> |
||
510 | <value>A list of the child bookmarks. Default value is an empty list.</value> |
||
511 | </member>
|
||
512 | <member name="P:Leadtools.Documents.DocumentBookmark.FontStyles"> |
||
513 | <summary>Optional font style to use when rendering the title.</summary> |
||
514 | <value>The optional font style to use when rendering the title. Default value is DocumentFontStyles.Normal.</value> |
||
515 | </member>
|
||
516 | <member name="P:Leadtools.Documents.DocumentBookmark.Target"> |
||
517 | <summary>Target for this bookmark.</summary> |
||
518 | <value>The target for this bookmark. Default value is a default DocumentLinkTarget object.</value> |
||
519 | </member>
|
||
520 | <member name="P:Leadtools.Documents.DocumentBookmark.Title"> |
||
521 | <summary>Title (caption) of this bookmark.</summary> |
||
522 | <value>The title (caption) of this bookmark. Default value is **null**.</value> |
||
523 | </member>
|
||
524 | <member name="T:Leadtools.Documents.DocumentDescriptor"> |
||
525 | <summary>JSON serilizable object that describes a document.</summary> |
||
526 | </member>
|
||
527 | <member name="M:Leadtools.Documents.DocumentDescriptor.#ctor"> |
||
528 | <summary>Initializes a new instance of this class.</summary> |
||
529 | </member>
|
||
530 | <member name="P:Leadtools.Documents.DocumentDescriptor.AutoDeleteFromCache"> |
||
531 | <summary>Indicates whether to automatically delete this document from the cache.</summary> |
||
532 | <value>Refer to AutoDeleteFromCache.</value> |
||
533 | </member>
|
||
534 | <member name="P:Leadtools.Documents.DocumentDescriptor.AutoDisposeDocuments"> |
||
535 | <summary>Indicates whether to automatically dispose any child documents.</summary> |
||
536 | <value>Refer to AutoDisposeDocuments.</value> |
||
537 | </member>
|
||
538 | <member name="P:Leadtools.Documents.DocumentDescriptor.AutoParseLinks"> |
||
539 | <summary>Indicate whether links are parsed automatically.</summary> |
||
540 | <value>Refer to AutoParseLinks.</value> |
||
541 | </member>
|
||
542 | <member name="P:Leadtools.Documents.DocumentDescriptor.AutoSaveToCache"> |
||
543 | <summary>Indicates whether to automatically save this document to the cache.</summary> |
||
544 | <value>Refer to AutoSaveToCache.</value> |
||
545 | </member>
|
||
546 | <member name="P:Leadtools.Documents.DocumentDescriptor.CacheOptions"> |
||
547 | <summary>Cache options.</summary> |
||
548 | <value>Refer to CacheOptions.</value> |
||
549 | </member>
|
||
550 | <member name="P:Leadtools.Documents.DocumentDescriptor.DefaultBitsPerPixel"> |
||
551 | <summary>Default bits per pixel.</summary> |
||
552 | <value>Refer to DefaultBitsPerPixel.</value> |
||
553 | </member>
|
||
554 | <member name="P:Leadtools.Documents.DocumentDescriptor.DefaultPageSize"> |
||
555 | <summary>Default page size.</summary> |
||
556 | <value>Refer to DefaultPageSize.</value> |
||
557 | </member>
|
||
558 | <member name="P:Leadtools.Documents.DocumentDescriptor.DefaultResolution"> |
||
559 | <summary>Default resolution.</summary> |
||
560 | <value>Refer to DefaultResolution.</value> |
||
561 | </member>
|
||
562 | <member name="P:Leadtools.Documents.DocumentDescriptor.DocumentId"> |
||
563 | <summary>Document ID.</summary> |
||
564 | <value>Refer to DocumentId.</value> |
||
565 | </member>
|
||
566 | <member name="P:Leadtools.Documents.DocumentDescriptor.DocumentType"> |
||
567 | <summary>Document type.</summary> |
||
568 | <value>Refer to DocumentType.</value> |
||
569 | </member>
|
||
570 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsReadOnly"> |
||
571 | <summary>Indicates whether this document is read-only.</summary> |
||
572 | <value>Refer to IsReadOnly.</value> |
||
573 | </member>
|
||
574 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsResolutionsSupported"> |
||
575 | <summary>Indicate whether resolutions are supported.</summary> |
||
576 | <value>Refer to IsResolutionsSupported.</value> |
||
577 | </member>
|
||
578 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsStructureParsed"> |
||
579 | <summary>Indicate whether the structure is parsed.</summary> |
||
580 | <value>Refer to IsParsed.</value> |
||
581 | </member>
|
||
582 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsStructureSupported"> |
||
583 | <summary>Indicate whether structure is supported.</summary> |
||
584 | <value>Refer to IsStructureSupported.</value> |
||
585 | </member>
|
||
586 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsSvgSupported"> |
||
587 | <summary>Indicate whether SVG is supported.</summary> |
||
588 | <value>Refer to IsSvgSupported.</value> |
||
589 | </member>
|
||
590 | <member name="P:Leadtools.Documents.DocumentDescriptor.IsSvgViewingPreferred"> |
||
591 | <summary>Indicate whether SVG viewing is preferred.</summary> |
||
592 | <value>Refer to IsSvgViewingPreferred.</value> |
||
593 | </member>
|
||
594 | <member name="P:Leadtools.Documents.DocumentDescriptor.LoadDocumentOptions"> |
||
595 | <summary>Load document options.</summary> |
||
596 | <value>Refer to LoadDocumentOptions.</value> |
||
597 | </member>
|
||
598 | <member name="P:Leadtools.Documents.DocumentDescriptor.MaximumImagePixelSize"> |
||
599 | <summary>Maximum image pixel size.</summary> |
||
600 | <value>Refer to MaximumImagePixelSize.</value> |
||
601 | </member>
|
||
602 | <member name="P:Leadtools.Documents.DocumentDescriptor.Metadata"> |
||
603 | <summary>Metadata serialized as a string.</summary> |
||
604 | <value>Refer to Metadata.</value> |
||
605 | </member>
|
||
606 | <member name="P:Leadtools.Documents.DocumentDescriptor.MimeType"> |
||
607 | <summary>Mime type of the document.</summary> |
||
608 | <value>Refer to MimeType.</value> |
||
609 | </member>
|
||
610 | <member name="P:Leadtools.Documents.DocumentDescriptor.Name"> |
||
611 | <summary>Document name.</summary> |
||
612 | <value>Refer to Name.</value> |
||
613 | </member>
|
||
614 | <member name="P:Leadtools.Documents.DocumentDescriptor.Pages"> |
||
615 | <summary>Pages of this document.</summary> |
||
616 | <value>Refer to Pages.</value> |
||
617 | </member>
|
||
618 | <member name="P:Leadtools.Documents.DocumentDescriptor.ParseBookmarks"> |
||
619 | <summary>Indicate whether to parse the bookmarks.</summary> |
||
620 | <value>Refer to ParseBookmarks.</value> |
||
621 | </member>
|
||
622 | <member name="P:Leadtools.Documents.DocumentDescriptor.ParsePageLinks"> |
||
623 | <summary>Indicate whether to parse the page links.</summary> |
||
624 | <value>Refer to ParsePageLinks.</value> |
||
625 | </member>
|
||
626 | <member name="P:Leadtools.Documents.DocumentDescriptor.TextExtractionMode"> |
||
627 | <summary>Text extraction mode.</summary> |
||
628 | <value>Refer to TextExtractionMode.</value> |
||
629 | </member>
|
||
630 | <member name="P:Leadtools.Documents.DocumentDescriptor.ThumbnailPixelSize"> |
||
631 | <summary>Thumbnail pixel size.</summary> |
||
632 | <value>Refer to ThumbnailPixelSize.</value> |
||
633 | </member>
|
||
634 | <member name="P:Leadtools.Documents.DocumentDescriptor.UnembedSvgImages"> |
||
635 | <summary>Indicate whether to unembed SVG images.</summary> |
||
636 | <value>Refer to UnembedSvgImages.</value> |
||
637 | </member>
|
||
638 | <member name="T:Leadtools.Documents.DocumentDocuments"> |
||
639 | <summary>Represents a collection of Document objects.</summary> |
||
640 | </member>
|
||
641 | <member name="M:Leadtools.Documents.DocumentDocuments.ClearItems"> |
||
642 | <summary>Overrides LeadCollection.ClearItems.</summary> |
||
643 | </member>
|
||
644 | <member name="M:Leadtools.Documents.DocumentDocuments.InsertItem(System.Int32,Leadtools.Documents.Document)"> |
||
645 | <summary>Overrides LeadCollection.InsertItem.</summary> |
||
646 | <param name="index">Index of new the item.</param> |
||
647 | <param name="item">Document to insert to the collection.</param> |
||
648 | </member>
|
||
649 | <member name="M:Leadtools.Documents.DocumentDocuments.MoveItem(System.Int32,System.Int32)"> |
||
650 | <summary>Overrides LeadCollection.MoveItem.</summary> |
||
651 | <param name="oldIndex">Old item new index.</param> |
||
652 | <param name="newIndex">New item index.</param> |
||
653 | </member>
|
||
654 | <member name="M:Leadtools.Documents.DocumentDocuments.RemoveItem(System.Int32)"> |
||
655 | <summary>Overrides LeadCollection.RemoveItem.</summary> |
||
656 | <param name="index">Index of the item to remove</param> |
||
657 | </member>
|
||
658 | <member name="M:Leadtools.Documents.DocumentDocuments.SetItem(System.Int32,Leadtools.Documents.Document)"> |
||
659 | <summary>Overrides LeadCollection.SetItem.</summary> |
||
660 | <param name="index">Index of the item to replace.</param> |
||
661 | <param name="item">Document to set.</param> |
||
662 | </member>
|
||
663 | <member name="P:Leadtools.Documents.DocumentDocuments.Document"> |
||
664 | <summary>Owner document of this DocumentDocuments</summary> |
||
665 | <value>The owner Document object of this DocumentDocuments.</value> |
||
666 | </member>
|
||
667 | <member name="T:Leadtools.Documents.DocumentFactory"> |
||
668 | <summary>Provide supports to load and create Document objects as well as managing the global cache.</summary> |
||
669 | </member>
|
||
670 | <member name="M:Leadtools.Documents.DocumentFactory.AbortUploadDocument(Leadtools.Caching.ObjectCache,System.Uri)"> |
||
671 | <summary>Abort uploading a document from the specified cache and delete all the stored data.</summary> |
||
672 | <param name="cache">The cache used when uploading this document. This value cannot be **null**.</param> |
||
673 | <param name="uri">The temporary document URL. This must be the same value returned from BeginUpload and cannot be</param> |
||
674 | </member>
|
||
675 | <member name="M:Leadtools.Documents.DocumentFactory.AbortUploadDocument(System.Uri)"> |
||
676 | <summary>Abort uploading a document and delete all the stored data.</summary> |
||
677 | <param name="uri">The temporary document URL. This must be the same value returned from BeginUpload and cannot be</param> |
||
678 | </member>
|
||
679 | <member name="M:Leadtools.Documents.DocumentFactory.BeginUpload(Leadtools.Documents.UploadDocumentOptions)"> |
||
680 | <summary>Start uploading a document to the cache.</summary> |
||
681 | <param name="options">Options to use with the new document. This value cannot be **null**.</param> |
||
682 | <returns>The temporary URL for the uploaded document.</returns> |
||
683 | </member>
|
||
684 | <member name="M:Leadtools.Documents.DocumentFactory.Create(Leadtools.Documents.CreateDocumentOptions)"> |
||
685 | <summary>Creates a new empty virtual document.</summary> |
||
686 | <param name="options">Options to use when creating the document. Cannot be **null**.</param> |
||
687 | <returns>The newly created document.</returns> |
||
688 | </member>
|
||
689 | <member name="M:Leadtools.Documents.DocumentFactory.Create(System.String,Leadtools.Documents.CreateDocumentOptions)"> |
||
690 | <summary>Creates a new empty document.</summary> |
||
691 | <param name="documentType">Document type. Cannot be **null**.</param> |
||
692 | <param name="options">Options to use when creating the document. Cannot be **null**.</param> |
||
693 | <returns>The newly created document.</returns> |
||
694 | </member>
|
||
695 | <member name="M:Leadtools.Documents.DocumentFactory.DeleteFromCache(Leadtools.Caching.ObjectCache,System.String)"> |
||
696 | <summary>Deletes a document from the specified cache.</summary> |
||
697 | <param name="cache">The cache object to use. This value cannot be **null**.</param> |
||
698 | <param name="documentId">The document identifier. This value cannot be **null**.</param> |
||
699 | <returns>Use this method to delete a document previously stored in the cache with SaveToCache.</returns> |
||
700 | </member>
|
||
701 | <member name="M:Leadtools.Documents.DocumentFactory.DeleteFromCache(System.String)"> |
||
702 | <summary>Deletes a document from the global cache.</summary> |
||
703 | <param name="documentId">The document identifier. This value cannot be **null**.</param> |
||
704 | <returns>This method is the equivalant of calling DeleteFromCache(DocumentFactory.Cache, documentId) and therefore</returns> |
||
705 | </member>
|
||
706 | <member name="M:Leadtools.Documents.DocumentFactory.IsUploadDocumentUri(System.Uri)"> |
||
707 | <summary>Indicates whether the URL points to a special LEAD cache scheme.</summary> |
||
708 | <param name="uri">Uri to check.</param> |
||
709 | <returns>This is a helper method that can be used to detect whether a URL was created by BeginUpload.</returns> |
||
710 | </member>
|
||
711 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromCache(Leadtools.Caching.ObjectCache,System.String)"> |
||
712 | <summary>Loads a previously saved document from the specified cache.</summary> |
||
713 | <param name="cache">The cache object to use. This value cannot be **null**.</param> |
||
714 | <param name="documentId">The document identifier. This value cannot be **null**.</param> |
||
715 | <returns>The document object if found in the cache, otherwise; **null**.</returns> |
||
716 | </member>
|
||
717 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromCache(System.String)"> |
||
718 | <summary>Loads a previously saved document from the global cache.</summary> |
||
719 | <param name="documentId">The document identifier. This value cannot be **null**.</param> |
||
720 | <returns>The document object if found in the cache, otherwise; **null**.</returns> |
||
721 | </member>
|
||
722 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromFile(System.String,Leadtools.Documents.LoadDocumentOptions)"> |
||
723 | <summary>Loads a document from existing data stored in a disk file.</summary> |
||
724 | <param name="fileName">Path to the file name containing the original document data. This value cannot be **null**.</param> |
||
725 | <param name="options">Options to use when loading the document. This value cannot be **null**.</param> |
||
726 | <returns>The newly created document object.</returns> |
||
727 | </member>
|
||
728 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromStream(System.IO.Stream,Leadtools.Documents.LoadDocumentOptions)"> |
||
729 | <summary>Loads a document from existing data stored in a stream.</summary> |
||
730 | <param name="stream">Stream containing the original document data. This value cannot be **null** and the stream must be seekable.</param> |
||
731 | <param name="options">Options to use when loading the document. This value cannot be **null**.</param> |
||
732 | <returns>The newly created document object.</returns> |
||
733 | </member>
|
||
734 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromUri(System.Uri,Leadtools.Documents.LoadDocumentOptions)"> |
||
735 | <summary>Loads a document from existing data stored in a remote URL.</summary> |
||
736 | <param name="uri">Path to the URL containing the original document data. This value cannot be **null**.</param> |
||
737 | <param name="options">Options to use when loading the document. This value cannot be **null**.</param> |
||
738 | <returns>The newly created document object.</returns> |
||
739 | </member>
|
||
740 | <member name="M:Leadtools.Documents.DocumentFactory.LoadFromUriAsync(System.Uri,Leadtools.Documents.LoadDocumentAsyncOptions)"> |
||
741 | <summary>Loads a document asynchronously from existing data stored in a remote URL.</summary> |
||
742 | <param name="uri">Path to the URL containing the original document data. This value cannot be **null**.</param> |
||
743 | <param name="options">Options to use when loading the document. This value cannot be **null**.</param> |
||
744 | </member>
|
||
745 | <member name="M:Leadtools.Documents.DocumentFactory.UploadDocument(Leadtools.Caching.ObjectCache,System.Uri,System.Byte[],System.Int32,System.Int32)"> |
||
746 | <summary>Upload a chunk of the document to the specified cache.</summary> |
||
747 | <param name="cache">The cache used when uploading this document. This value cannot be **null**.</param> |
||
748 | <param name="uri">The temporary document URL. This must be the same value returned from BeginUpload and cannot be</param> |
||
749 | </member>
|
||
750 | <member name="M:Leadtools.Documents.DocumentFactory.UploadDocument(System.Uri,System.Byte[],System.Int32,System.Int32)"> |
||
751 | <summary>Upload a chunk of the document to the global cache.</summary> |
||
752 | <param name="uri">The temporary document URL. This must be the same value returned from BeginUpload and cannot be</param> |
||
753 | </member>
|
||
754 | <member name="P:Leadtools.Documents.DocumentFactory.Cache"> |
||
755 | <summary>The LEADTOOLS ObjectCache object responsible for managing cache items and expiration policies.</summary> |
||
756 | <value>The cache object responsible for managing cache items and expiration policies. Default value is **null**.</value> |
||
757 | </member>
|
||
758 | <member name="P:Leadtools.Documents.DocumentFactory.RasterCodecsTemplate"> |
||
759 | <summary>Global template used when loading and saving raster and SVG images.</summary> |
||
760 | <value>The global RasterCodecs template to use when loading and saving raster and SVG images. Default is a RasterCodecs</value> |
||
761 | </member>
|
||
762 | <member name="T:Leadtools.Documents.DocumentImages"> |
||
763 | <summary>Manages the global image settings for the document.</summary> |
||
764 | </member>
|
||
765 | <member name="M:Leadtools.Documents.DocumentImages.GetThumbnailsGrid(System.Int32,System.Int32,System.Int32)"> |
||
766 | <summary>Gets an image that contains one or more page thumbnails.</summary> |
||
767 | <param name="firstPageNumber">1-based number of the first page number in the document.</param> |
||
768 | <param name="lastPageNumber">1-based number of the last page number in the document.</param> |
||
769 | <param name="maximumGridWidth">The maximum width of the grid in pixels.</param> |
||
770 | <returns>A raster image object that contains the thumbnails in a grid layout.</returns> |
||
771 | </member>
|
||
772 | <member name="P:Leadtools.Documents.DocumentImages.DefaultBitsPerPixel"> |
||
773 | <summary>Bits per pixel to use when getting the raster image of a page.</summary> |
||
774 | <value>The bits per pixel to use when getting the raster image of a page. This value is determined by the document type.</value> |
||
775 | </member>
|
||
776 | <member name="P:Leadtools.Documents.DocumentImages.Document"> |
||
777 | <summary>Owner document of this DocumentAnnotations</summary> |
||
778 | <value>The owner Document object of this DocumentAnnotations.</value> |
||
779 | </member>
|
||
780 | <member name="P:Leadtools.Documents.DocumentImages.IsResolutionsSupported"> |
||
781 | <summary>Determine whether this document supports loading images using different resolutions.</summary> |
||
782 | <value>**true** if this document supports loading images using different resolutions (DPI), otherwise; **false**.</value> |
||
783 | </member>
|
||
784 | <member name="P:Leadtools.Documents.DocumentImages.IsSvgSupported"> |
||
785 | <summary>Indicates whether this document supports getting a page as SVG.</summary> |
||
786 | <value>**true** if this document supports getting a page as SVG, otherwise; **false**.</value> |
||
787 | </member>
|
||
788 | <member name="P:Leadtools.Documents.DocumentImages.IsSvgViewingPreferred"> |
||
789 | <summary>Indicates whether the pages in this document is best viewed using SVG instead of raster images.</summary> |
||
790 | <value>**true** if the pages in this document is best viewed using SVG instead of raster images, otherwise; **false**.</value> |
||
791 | </member>
|
||
792 | <member name="P:Leadtools.Documents.DocumentImages.MaximumImagePixelSize"> |
||
793 | <summary>Maximum width or height in pixels to use when obtaining image data from the pages in this document.</summary> |
||
794 | <value>The maximum width or height in pixels to use when obtaining image data from the pages in this document. Default value is 0 which means to use the original size.</value> |
||
795 | </member>
|
||
796 | <member name="P:Leadtools.Documents.DocumentImages.RasterCodecs"> |
||
797 | <summary>Raster codecs object used by this Document to load raster images and SVG documents.</summary> |
||
798 | <value>The raster codecs object used by this Document to load raster images and SVG documents.</value> |
||
799 | </member>
|
||
800 | <member name="P:Leadtools.Documents.DocumentImages.ThumbnailPixelSize"> |
||
801 | <summary>Size to use when getting the thumbnail image of a page.</summary> |
||
802 | <value>The size to use in pixels when getting the thumbnail image of a page. Default value is 128 by 128 pixels.</value> |
||
803 | </member>
|
||
804 | <member name="P:Leadtools.Documents.DocumentImages.UnembedSvgImages"> |
||
805 | <summary>Unembed the image elements inside the SVG.</summary> |
||
806 | <value>**true** to unembed the image elements inside the SVG; otherwise, **false**. Default value is **false**.</value> |
||
807 | </member>
|
||
808 | <member name="T:Leadtools.Documents.DocumentMetadata"> |
||
809 | <summary>Manages the metadata of the document.</summary> |
||
810 | </member>
|
||
811 | <member name="M:Leadtools.Documents.DocumentMetadata.#ctor"> |
||
812 | <summary>Initializes a new instance of the DocumentMetadata class with serialized data.</summary> |
||
813 | <param name="info">The object that holds the serialized object data.</param> |
||
814 | <param name="context">The contextual information about the source or destination.</param> |
||
815 | </member>
|
||
816 | <member name="M:Leadtools.Documents.DocumentMetadata.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
||
817 | <summary>Overrides System.Collections.Generic.Dictionary`2.</summary> |
||
818 | <param name="info">The System.Runtime.Serialization.SerializationInfo that holds the serialized object data for the object.</param> |
||
819 | <param name="context">The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.</param> |
||
820 | </member>
|
||
821 | <member name="P:Leadtools.Documents.DocumentMetadata.Document"> |
||
822 | <summary>Owner document of this DocumentMetadata</summary> |
||
823 | <value>The owner Document object of this DocumentMetadata.</value> |
||
824 | </member>
|
||
825 | <member name="T:Leadtools.Documents.DocumentPage"> |
||
826 | <summary>Represents a page in the current Document.</summary> |
||
827 | </member>
|
||
828 | <member name="M:Leadtools.Documents.DocumentPage.GetAnnotations(System.Boolean)"> |
||
829 | <summary>Gets the annotations container of this page.</summary> |
||
830 | <param name="createEmpty"></param> |
||
831 | <returns>The annotation container for this page if available, or **null**.</returns> |
||
832 | </member>
|
||
833 | <member name="M:Leadtools.Documents.DocumentPage.GetImage"> |
||
834 | <summary>Gets this page as a raster image.</summary> |
||
835 | <returns>This page as a RasterImage object.</returns> |
||
836 | </member>
|
||
837 | <member name="M:Leadtools.Documents.DocumentPage.GetImage"> |
||
838 | <summary>Gets this page as a raster image at the specified resolution.</summary> |
||
839 | <param name="resolution">Resolution to use in dots per inch. If this value is 0, then the current page Resolution value is used.</param> |
||
840 | <returns>This page as a RasterImage object.</returns> |
||
841 | </member>
|
||
842 | <member name="M:Leadtools.Documents.DocumentPage.GetLinks"> |
||
843 | <summary>Links of this page.</summary> |
||
844 | <returns>An array containing the links for this page if available, or **null**.</returns> |
||
845 | </member>
|
||
846 | <member name="M:Leadtools.Documents.DocumentPage.GetSvg(Leadtools.Codecs.CodecsLoadSvgOptions)"> |
||
847 | <summary>Gets this page as an SVG document with the specified options.</summary> |
||
848 | <param name="options">Options to use when creating the SVG document. It can be used to drop images, text or shapes from the returned document</param> |
||
849 | <param name=""></param> |
||
850 | <param name=""></param> |
||
851 | <param name="">2. If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system.</param> |
||
852 | <param name="">SvgDocument object is saved to the cache before it is returned. Next time this method is called, the SVG will be returned from the cache directly</param> |
||
853 | <param name="">return **null** as well.</param> |
||
854 | <returns>The SVG document of this page if found or **null**.</returns> |
||
855 | </member>
|
||
856 | <member name="M:Leadtools.Documents.DocumentPage.GetSvgBackImage(Leadtools.RasterColor)"> |
||
857 | <summary>Gets a raster image that represents contains only the image elements of the SVG document for this page using the default resolution.</summary> |
||
858 | <param name="backColor">Color to use to fill the background of the image.</param> |
||
859 | </member>
|
||
860 | <member name="M:Leadtools.Documents.DocumentPage.GetSvgBackImage(Leadtools.RasterColor,System.Int32)"> |
||
861 | <summary>Gets a raster image that represents contains only the image elements of the SVG document for this page.</summary> |
||
862 | <param name="backColor">Color to use to fill the background of the image.</param> |
||
863 | <param name="resolution">Resolution to use in dots per inch. If this value is 0, then the current page Resolution value is used.</param> |
||
864 | <returns>Raster image that represents contains only the image elements of the SVG document for this page if this page supports SVG and the SVG</returns> |
||
865 | </member>
|
||
866 | <member name="M:Leadtools.Documents.DocumentPage.GetText"> |
||
867 | <summary>Gets the text content of this page.</summary> |
||
868 | <returns>The text content of this DocumentPage as a DocumentPageText object.</returns> |
||
869 | </member>
|
||
870 | <member name="M:Leadtools.Documents.DocumentPage.GetText"> |
||
871 | <summary>Gets the text content of an area in this page.</summary> |
||
872 | <param name="clip">The region of interest area. If this value is Empty, then the text of the whole page is obtained.</param> |
||
873 | <returns>The text content of this DocumentPage as a DocumentPageText object.</returns> |
||
874 | </member>
|
||
875 | <member name="M:Leadtools.Documents.DocumentPage.GetThumbnailImage"> |
||
876 | <summary>Gets a thumbnail representation of this page.</summary> |
||
877 | <returns>The thumbnail representation of this page.</returns> |
||
878 | </member>
|
||
879 | <member name="M:Leadtools.Documents.DocumentPage.ReadBarcodes(Leadtools.LeadRectD,System.Int32,Leadtools.Barcode.BarcodeSymbology)"> |
||
880 | <summary>Read the barcodes found on this page.</summary> |
||
881 | <param name="bounds">Search area in page coordinates. If this value is Empty, then the whole page is searched for barcodes.</param> |
||
882 | <param name="maximumBarcodes">Maximum number of barcodes to read. Use -1 to read all the barcodes found.</param> |
||
883 | <param name="symbologies">Barcode symbologies to search for. If this value is **null** or an empty array, then all barcode symbologies are used.</param> |
||
884 | <returns>Array containing the data for each barcode found. An empty array is returned if no barcodes were found on the page.</returns> |
||
885 | </member>
|
||
886 | <member name="M:Leadtools.Documents.DocumentPage.SetAnnotations(Leadtools.Annotations.Core.AnnContainer)"> |
||
887 | <summary>Replaces the annotations container for this page.</summary> |
||
888 | <param name="container">New annotations container to use for this page. This value can be **null**.</param> |
||
889 | </member>
|
||
890 | <member name="M:Leadtools.Documents.DocumentPage.SetImage(Leadtools.RasterImage)"> |
||
891 | <summary>Replaces the raster image for this page.</summary> |
||
892 | <param name="image">New raster image to use for this page. This value can be **null**.</param> |
||
893 | </member>
|
||
894 | <member name="M:Leadtools.Documents.DocumentPage.SetLinks(Leadtools.Documents.DocumentLink)"> |
||
895 | <summary>Replaces the links of this page.</summary> |
||
896 | <param name="links">An array containing the new links for this page. A value of **null** is supported.</param> |
||
897 | </member>
|
||
898 | <member name="M:Leadtools.Documents.DocumentPage.SetSvg(Leadtools.Svg.SvgDocument,Leadtools.Codecs.CodecsLoadSvgOptions)"> |
||
899 | <summary>Replaces the SVG document for this page.</summary> |
||
900 | <param name="svg">New SVG document to use for this page. This value can be **null**.</param> |
||
901 | <param name="options">Options to use when caching this SVG document. It can be used to drop images, text or shapes before the document is saved</param> |
||
902 | <param name=""></param> |
||
903 | <param name="">2. This method requires that the owner document uses a cache system</param> |
||
904 | <param name="">3. If the value of the IsReadOnly property of Document is **true**, then</param> |
||
905 | <param name="">GetSvg will check the cache first, hence, subsequent calls will return the value set by this method.</param> |
||
906 | <param name="">Refer to Loading Using LEADTOOLS Documents Library for more information.</param> |
||
907 | </member>
|
||
908 | <member name="M:Leadtools.Documents.DocumentPage.SetSvgBackImage(Leadtools.RasterImage)"> |
||
909 | <summary>Replaces the SVG background image for this page.</summary> |
||
910 | <param name="image">New SVG background image to use for this page. This value can be **null**.</param> |
||
911 | </member>
|
||
912 | <member name="M:Leadtools.Documents.DocumentPage.SetText(Leadtools.Documents.DocumentPageText)"> |
||
913 | <summary>Replaces the text content for this page.</summary> |
||
914 | <param name="text">New text content to use for this page. This value can be **null**.</param> |
||
915 | </member>
|
||
916 | <member name="P:Leadtools.Documents.DocumentPage.CustomData"> |
||
917 | <summary>Dictionary of user-custom data to associate with this page.</summary> |
||
918 | <value>Dictionary of user-custom data to associate with this page.</value> |
||
919 | </member>
|
||
920 | <member name="P:Leadtools.Documents.DocumentPage.Document"> |
||
921 | <summary>Owner document of this DocumentPage</summary> |
||
922 | <value>The owner Document object of this DocumentPage.</value> |
||
923 | </member>
|
||
924 | <member name="P:Leadtools.Documents.DocumentPage.HasEmbeddedAnnotations"> |
||
925 | <summary>Indicates whether the original document has embedded annotations for this page.</summary> |
||
926 | <value>**true** if the original document has embedded annotations for this page, otherwise; **false**.</value> |
||
927 | </member>
|
||
928 | <member name="P:Leadtools.Documents.DocumentPage.ImageScale"> |
||
929 | <summary>Scale value used when retuning image objects of this page.</summary> |
||
930 | <value>The scale value used when retuning image objects of this page.</value> |
||
931 | </member>
|
||
932 | <member name="P:Leadtools.Documents.DocumentPage.IsAnnotationsModified"> |
||
933 | <summary>Indicates whether the annotations for this page has been replaced.</summary> |
||
934 | <value>**true** if the annotations for this page has been replaced, otherwise; **false**.</value> |
||
935 | </member>
|
||
936 | <member name="P:Leadtools.Documents.DocumentPage.IsDeleted"> |
||
937 | <summary>Determines whether this page is deleted.</summary> |
||
938 | <value>**true** if this page is deleted, otherwise; **false**. Default value is **null**.</value> |
||
939 | </member>
|
||
940 | <member name="P:Leadtools.Documents.DocumentPage.IsImageModified"> |
||
941 | <summary>Indicates whether the raster image for this page has been replaced.</summary> |
||
942 | <value>**true** if the raster image for this page has been replaced, otherwise; **false**.</value> |
||
943 | </member>
|
||
944 | <member name="P:Leadtools.Documents.DocumentPage.IsLinksModified"> |
||
945 | <summary>Indicates whether the links for this page has been replaced.</summary> |
||
946 | <value>**true** if the links for this page has been replaced, otherwise; **false**.</value> |
||
947 | </member>
|
||
948 | <member name="P:Leadtools.Documents.DocumentPage.IsLocal"> |
||
949 | <summary>Indicate that this page has been created by the user in this document.</summary> |
||
950 | <value>**true** if this page has been created by the user in this document; otherwise, **false**.</value> |
||
951 | </member>
|
||
952 | <member name="P:Leadtools.Documents.DocumentPage.IsSvgBackImageModified"> |
||
953 | <summary>Indicates whether the SVG background image for this page has been replaced.</summary> |
||
954 | <value>**true** if the SVG background image for this page has been replaced, otherwise; **false**.</value> |
||
955 | </member>
|
||
956 | <member name="P:Leadtools.Documents.DocumentPage.IsSvgModified"> |
||
957 | <summary>Indicates whether the SVG document for this page has been replaced.</summary> |
||
958 | <value>**true** if the SVG document for this page has been replaced, otherwise; **false**.</value> |
||
959 | </member>
|
||
960 | <member name="P:Leadtools.Documents.DocumentPage.IsSvgSupported"> |
||
961 | <summary>Indicates whether this page supports SVG.</summary> |
||
962 | <value>**true** if this page supports SVG, otherwise; **false**.</value> |
||
963 | </member>
|
||
964 | <member name="P:Leadtools.Documents.DocumentPage.IsTextModified"> |
||
965 | <summary>Indicates whether the text content for this page has been replaced.</summary> |
||
966 | <value>**true** if the text content for this page has been replaced, otherwise; **false**.</value> |
||
967 | </member>
|
||
968 | <member name="P:Leadtools.Documents.DocumentPage.OriginalPageNumber"> |
||
969 | <summary>The number of this page in the original document.</summary> |
||
970 | <value>1-based number of this page in the original document.</value> |
||
971 | </member>
|
||
972 | <member name="P:Leadtools.Documents.DocumentPage.PageNumber"> |
||
973 | <summary>The current number of this page in the document.</summary> |
||
974 | <value>The 1-based number of this DocumentPage in the document.</value> |
||
975 | </member>
|
||
976 | <member name="P:Leadtools.Documents.DocumentPage.Resolution"> |
||
977 | <summary>Resolution of this page.</summary> |
||
978 | <value>The resolution of this DocumentPage in dots per inch (DPI).</value> |
||
979 | </member>
|
||
980 | <member name="P:Leadtools.Documents.DocumentPage.Size"> |
||
981 | <summary>Size of this page.</summary> |
||
982 | <value>The size of this DocumentPage in document units.</value> |
||
983 | </member>
|
||
984 | <member name="P:Leadtools.Documents.DocumentPage.UserData"> |
||
985 | <summary>The user-defined data associated with this page.</summary> |
||
986 | <value>Any object that can be used as the user-defined data associated with this page. Default value is **null**.</value> |
||
987 | </member>
|
||
988 | <member name="T:Leadtools.Documents.DocumentPageDescriptor"> |
||
989 | <summary>JSON serilizable object that describes a page in the document.</summary> |
||
990 | </member>
|
||
991 | <member name="M:Leadtools.Documents.DocumentPageDescriptor.#ctor"> |
||
992 | <summary>Initializes a new instance of this class.</summary> |
||
993 | </member>
|
||
994 | <member name="P:Leadtools.Documents.DocumentPageDescriptor.DocumentId"> |
||
995 | <summary>ID of the owner document</summary> |
||
996 | <value>Refer to Document.</value> |
||
997 | </member>
|
||
998 | <member name="P:Leadtools.Documents.DocumentPageDescriptor.PageNumber"> |
||
999 | <summary>Page number in the owner document</summary> |
||
1000 | <value>Refer to PageNumber.</value> |
||
1001 | </member>
|
||
1002 | <member name="P:Leadtools.Documents.DocumentPageDescriptor.Resolution"> |
||
1003 | <summary>Resolution of this page in dots per inch.</summary> |
||
1004 | <value>Refer to Resolution.</value> |
||
1005 | </member>
|
||
1006 | <member name="P:Leadtools.Documents.DocumentPageDescriptor.Size"> |
||
1007 | <summary>Size of this page in document units.</summary> |
||
1008 | <value>Refer to Size.</value> |
||
1009 | </member>
|
||
1010 | <member name="T:Leadtools.Documents.DocumentPages"> |
||
1011 | <summary>Represents a collection of DocumentPage objects.</summary> |
||
1012 | </member>
|
||
1013 | <member name="M:Leadtools.Documents.DocumentPages.CreatePage(Leadtools.LeadSizeD,System.Double)"> |
||
1014 | <summary>Creates a new DocumentPage</summary> |
||
1015 | <param name="size">Size of the new page in document units. Cannot be empty (Empty).</param> |
||
1016 | <param name="resolution">The resolution of the new page in dots per inch (DPI). Must be greater than or equal 0. A value of 0 means</param> |
||
1017 | <returns>The newly created page.</returns> |
||
1018 | </member>
|
||
1019 | <member name="M:Leadtools.Documents.DocumentPages.GetTargetPageNumber(Leadtools.Documents.Document,System.Int32)"> |
||
1020 | <summary>Finds the page number in this document that corresponds to a page number in another source document.</summary> |
||
1021 | <param name="sourceDocument">Source document. Must not be **null**.</param> |
||
1022 | <param name="sourcePageNumber">1-based page number in the source document.</param> |
||
1023 | <returns>The 1-based page number in this document if found, -1 otherwise.</returns> |
||
1024 | </member>
|
||
1025 | <member name="M:Leadtools.Documents.DocumentPages.ClearItems"> |
||
1026 | <summary>Overrides LeadCollection.ClearItems.</summary> |
||
1027 | </member>
|
||
1028 | <member name="M:Leadtools.Documents.DocumentPages.InsertItem(System.Int32,Leadtools.Documents.DocumentPage)"> |
||
1029 | <summary>Overrides LeadCollection.InsertItem.</summary> |
||
1030 | <param name="index">Index of new the item.</param> |
||
1031 | <param name="item">Page to insert to the collection.</param> |
||
1032 | </member>
|
||
1033 | <member name="M:Leadtools.Documents.DocumentPages.MoveItem(System.Int32,System.Int32)"> |
||
1034 | <summary>Overrides LeadCollection.MoveItem.</summary> |
||
1035 | <param name="oldIndex">Old item new index.</param> |
||
1036 | <param name="newIndex">New item index.</param> |
||
1037 | </member>
|
||
1038 | <member name="M:Leadtools.Documents.DocumentPages.RemoveItem(System.Int32)"> |
||
1039 | <summary>Overrides LeadCollection.RemoveItem.</summary> |
||
1040 | <param name="index">Index of the item to remove</param> |
||
1041 | </member>
|
||
1042 | <member name="M:Leadtools.Documents.DocumentPages.SetItem(System.Int32,Leadtools.Documents.DocumentPage)"> |
||
1043 | <summary>Overrides LeadCollection.SetItem.</summary> |
||
1044 | <param name="index">Index of the item to replace.</param> |
||
1045 | <param name="item">Page to set.</param> |
||
1046 | </member>
|
||
1047 | <member name="P:Leadtools.Documents.DocumentPages.DefaultPageSize"> |
||
1048 | <summary>Default page size of this document.</summary> |
||
1049 | <value>The default page size of this document. Default value depends on how this document was created.</value> |
||
1050 | </member>
|
||
1051 | <member name="P:Leadtools.Documents.DocumentPages.DefaultResolution"> |
||
1052 | <summary>Default resolution in dots per inch of this document.</summary> |
||
1053 | <value>The default resolution in dots per inch (DPI) of this document. Default value depends on how this document was created.</value> |
||
1054 | </member>
|
||
1055 | <member name="P:Leadtools.Documents.DocumentPages.Document"> |
||
1056 | <summary>Owner document of this DocumentPages</summary> |
||
1057 | <value>The owner Document object of this DocumentPages.</value> |
||
1058 | </member>
|
||
1059 | <member name="P:Leadtools.Documents.DocumentPages.OriginalFirstPageNumber"> |
||
1060 | <summary>The number of the first page loaded into this document.</summary> |
||
1061 | <value>The number of the first page loaded into this document.</value> |
||
1062 | </member>
|
||
1063 | <member name="P:Leadtools.Documents.DocumentPages.OriginalLastPageNumber"> |
||
1064 | <summary>The number of the last page loaded into this document.</summary> |
||
1065 | <value>The number of the last page loaded into this document.</value> |
||
1066 | </member>
|
||
1067 | <member name="P:Leadtools.Documents.DocumentPages.OriginalPageCount"> |
||
1068 | <summary>The number of pages in the original document.</summary> |
||
1069 | <value>The number of pages in the original document.</value> |
||
1070 | </member>
|
||
1071 | <member name="T:Leadtools.Documents.DocumentPageText"> |
||
1072 | <summary>Contains the text characters and words found in a document page.</summary> |
||
1073 | </member>
|
||
1074 | <member name="M:Leadtools.Documents.DocumentPageText.#ctor"> |
||
1075 | <summary>Initializes a new instance of DocumentPageText.</summary> |
||
1076 | </member>
|
||
1077 | <member name="M:Leadtools.Documents.DocumentPageText.BuildText"> |
||
1078 | <summary>Build the text found in the document page as a simple string object.</summary> |
||
1079 | </member>
|
||
1080 | <member name="M:Leadtools.Documents.DocumentPageText.BuildTextWithMap"> |
||
1081 | <summary>Build the text found in the document page with extra map back into the characters list.</summary> |
||
1082 | </member>
|
||
1083 | <member name="M:Leadtools.Documents.DocumentPageText.BuildWords"> |
||
1084 | <summary>Build a list of the words found in the document page.</summary> |
||
1085 | </member>
|
||
1086 | <member name="M:Leadtools.Documents.DocumentPageText.ClearBuildData"> |
||
1087 | <summary>Clears the generated words, text and map values.</summary> |
||
1088 | </member>
|
||
1089 | <member name="M:Leadtools.Documents.DocumentPageText.ClipText(Leadtools.LeadRectD)"> |
||
1090 | <summary>Creates a new DocumentPageText from a portion of this text data.</summary> |
||
1091 | <param name="bounds">The area to clone. This value is in document coordinates.</param> |
||
1092 | <returns>New DocumentPageText that contains only the characters that are included in bounds.</returns> |
||
1093 | </member>
|
||
1094 | <member name="M:Leadtools.Documents.DocumentPageText.FromSvgDocument(Leadtools.Svg.SvgDocument,Leadtools.Documents.Document)"> |
||
1095 | <summary>Parses the text from an SVG document.</summary> |
||
1096 | <param name="document">Source SVG document. This value must not be **null**.</param> |
||
1097 | <param name="mappingDocument">The owner document of the SVG. This is used to map the location and size of the items found into document coordinates. If this</param> |
||
1098 | <param name=""></param> |
||
1099 | <returns>The object containing the text found in the SVG document.</returns> |
||
1100 | </member>
|
||
1101 | <member name="M:Leadtools.Documents.DocumentPageText.ParseLinks(System.Collections.Generic.IList<System.Text.RegularExpressions.Regex>)"> |
||
1102 | <summary>Parses the links found in this DocumentText.</summary> |
||
1103 | <param name="linkPatterns">A list of System.Text.RegularExpressions.Regex objects to use for parsing the links.</param> |
||
1104 | <returns>A list of the links parsed.</returns> |
||
1105 | </member>
|
||
1106 | <member name="P:Leadtools.Documents.DocumentPageText.Characters"> |
||
1107 | <summary>The list of text characters found in the document page.</summary> |
||
1108 | <value>List of text characters found in the document page. The default value is an empty list.</value> |
||
1109 | </member>
|
||
1110 | <member name="P:Leadtools.Documents.DocumentPageText.Text"> |
||
1111 | <summary>The text found in the document page.</summary> |
||
1112 | <value>The text found in the document page as a simple string object. Default value is **null**.</value> |
||
1113 | </member>
|
||
1114 | <member name="P:Leadtools.Documents.DocumentPageText.TextMap"> |
||
1115 | <summary>List that contains the indices into Characters of each character in Text</summary> |
||
1116 | <value>A list of integers that contain the indices into Characters of each character in Text. Default value is **null**.</value> |
||
1117 | </member>
|
||
1118 | <member name="P:Leadtools.Documents.DocumentPageText.Words"> |
||
1119 | <summary>The list of text words found in the document page.</summary> |
||
1120 | <value>List of text words found in the document page. The default value is **null**.</value> |
||
1121 | </member>
|
||
1122 | <member name="T:Leadtools.Documents.DocumentStructure"> |
||
1123 | <summary>Manages the structure of the document.</summary> |
||
1124 | </member>
|
||
1125 | <member name="M:Leadtools.Documents.DocumentStructure.Parse"> |
||
1126 | <summary>Parse the structure of this document and read the bookmarks and table of content.</summary> |
||
1127 | </member>
|
||
1128 | <member name="P:Leadtools.Documents.DocumentStructure.Bookmarks"> |
||
1129 | <summary>The list of bookmarks (table of content) in this document.</summary> |
||
1130 | <value>The list of bookmarks (table of content) in this document.</value> |
||
1131 | </member>
|
||
1132 | <member name="P:Leadtools.Documents.DocumentStructure.Document"> |
||
1133 | <summary>Owner document of this DocumentStructure</summary> |
||
1134 | <value>The owner Document object of this DocumentStructure.</value> |
||
1135 | </member>
|
||
1136 | <member name="P:Leadtools.Documents.DocumentStructure.IsParsed"> |
||
1137 | <summary>Indicates whether the structure of this document has been parsed.</summary> |
||
1138 | <value>**true** if the structure of this document has been parsed, otherwise; **false**.</value> |
||
1139 | </member>
|
||
1140 | <member name="P:Leadtools.Documents.DocumentStructure.ParseBookmarks"> |
||
1141 | <summary>Indicates whether to parse the bookmarks from the original document.</summary> |
||
1142 | <value>**true** to parse the bookmarks from the original document when Parse is called, otherwise; **false**.</value> |
||
1143 | </member>
|
||
1144 | <member name="P:Leadtools.Documents.DocumentStructure.ParsePageLinks"> |
||
1145 | <summary>Indicates whether to parse the links found in the pages from the original document.</summary> |
||
1146 | <value>**true** to parse the links found in the pages from the original document when Parse is called, otherwise; **false**.</value> |
||
1147 | </member>
|
||
1148 | <member name="T:Leadtools.Documents.DocumentText"> |
||
1149 | <summary>Manages the text options of the document.</summary> |
||
1150 | </member>
|
||
1151 | <member name="M:Leadtools.Documents.DocumentText.ResetLinkPatterns"> |
||
1152 | <summary>Resets the regular expressions list used when parsing links from text to the default value.</summary> |
||
1153 | </member>
|
||
1154 | <member name="P:Leadtools.Documents.DocumentText.AutoParseLinks"> |
||
1155 | <summary>Indicates whether to parse links from the text of the pages.</summary> |
||
1156 | <value>**true** to parse links from the text of the pages, otherwise; **false**. Default value is **true**.</value> |
||
1157 | </member>
|
||
1158 | <member name="P:Leadtools.Documents.DocumentText.Document"> |
||
1159 | <summary>Owner document of this DocumentText</summary> |
||
1160 | <value>The owner Document object of this DocumentText.</value> |
||
1161 | </member>
|
||
1162 | <member name="P:Leadtools.Documents.DocumentText.LinkPatterns"> |
||
1163 | <summary>Regular expressions to use when parsing links from text.</summary> |
||
1164 | <value>A list of the regular expressions to use when parsing links from text. The default value is</value> |
||
1165 | </member>
|
||
1166 | <member name="P:Leadtools.Documents.DocumentText.OcrEngine"> |
||
1167 | <summary>Optional OCR engine instance to use when extracting text.</summary> |
||
1168 | <value>The optional OCR engine instance to use when extracting text. Default value is **null**.</value> |
||
1169 | </member>
|
||
1170 | <member name="P:Leadtools.Documents.DocumentText.TextExtractionMode"> |
||
1171 | <summary>Mode to use when extracting text from this document.</summary> |
||
1172 | <value>The mode to use when extracting text from this document. Default value is DocumentTextExtractionMode.Auto.</value> |
||
1173 | </member>
|
||
1174 | <member name="T:Leadtools.Documents.LoadAsyncCompletedEventArgs"> |
||
1175 | <summary>Data for the LoadDocumentAsyncOptions.Completed event.</summary> |
||
1176 | </member>
|
||
1177 | <member name="P:Leadtools.Documents.LoadAsyncCompletedEventArgs.Document"> |
||
1178 | <summary>The loaded Document object.</summary> |
||
1179 | <value>The result loaded Document object if the load operation was successful, otherwise; **null**.</value> |
||
1180 | </member>
|
||
1181 | <member name="P:Leadtools.Documents.LoadAsyncCompletedEventArgs.Uri"> |
||
1182 | <summary>The location of the document loaded.</summary> |
||
1183 | <value>The location of the document loaded. This is the uri value passed to LoadFromUriAsync.</value> |
||
1184 | </member>
|
||
1185 | <member name="T:Leadtools.Documents.LoadAsyncProgressEventArgs"> |
||
1186 | <summary>Data for the LoadDocumentAsyncOptions.Progress event.</summary> |
||
1187 | </member>
|
||
1188 | <member name="P:Leadtools.Documents.LoadAsyncProgressEventArgs.BytesReceived"> |
||
1189 | <summary>Number of bytes received during this chunk of the operation.</summary> |
||
1190 | <value>Number of bytes received during this chunk of the operation.</value> |
||
1191 | </member>
|
||
1192 | <member name="P:Leadtools.Documents.LoadAsyncProgressEventArgs.IsCancelPending"> |
||
1193 | <summary>Abort the load operation.</summary> |
||
1194 | <value>**true** to abort the current load operation, otherwise; **false**. Default value is **false**.</value> |
||
1195 | </member>
|
||
1196 | <member name="P:Leadtools.Documents.LoadAsyncProgressEventArgs.TotalBytesToReceive"> |
||
1197 | <summary>Total number of bytes received so far for the whole load operation.</summary> |
||
1198 | <value>The total number of bytes received so far for the whole load operation.</value> |
||
1199 | </member>
|
||
1200 | <member name="P:Leadtools.Documents.LoadAsyncProgressEventArgs.Uri"> |
||
1201 | <summary>The location of the document being loaded</summary> |
||
1202 | <value>The location of the document being loaded. This is the uri value passed to LoadFromUriAsync.</value> |
||
1203 | </member>
|
||
1204 | <member name="T:Leadtools.Documents.LoadDocumentAsyncOptions"> |
||
1205 | <summary>Options to use when loading a document asynchronously.</summary> |
||
1206 | </member>
|
||
1207 | <member name="M:Leadtools.Documents.LoadDocumentAsyncOptions.#ctor"> |
||
1208 | <summary>Initializes a new instance of LoadDocumentAsyncOptions with default parameters.</summary> |
||
1209 | </member>
|
||
1210 | <member name="E:Leadtools.Documents.LoadDocumentAsyncOptions.Completed"> |
||
1211 | <summary>Event that occurs when the factory finishes loading the document successfully or otherwise.</summary> |
||
1212 | </member>
|
||
1213 | <member name="E:Leadtools.Documents.LoadDocumentAsyncOptions.Progress"> |
||
1214 | <summary>Event that occurs one or more times while the factory is loading the document to indicate the current progress.</summary> |
||
1215 | </member>
|
||
1216 | <member name="P:Leadtools.Documents.LoadDocumentAsyncOptions.UserState"> |
||
1217 | <summary>The user-defined state object associated with this operation.</summary> |
||
1218 | <value>Optional user-defined state object associated with this operation. Default value is **null**.</value> |
||
1219 | </member>
|
||
1220 | <member name="T:Leadtools.Documents.LoadDocumentOptions"> |
||
1221 | <summary>Options to use when loading a document.</summary> |
||
1222 | </member>
|
||
1223 | <member name="M:Leadtools.Documents.LoadDocumentOptions.#ctor"> |
||
1224 | <summary>Initializes a new instance of LoadDocumentOptions with default parameters.</summary> |
||
1225 | </member>
|
||
1226 | <member name="P:Leadtools.Documents.LoadDocumentOptions.AnnotationsUri"> |
||
1227 | <summary>The location to the external annotation file associated with the document.</summary> |
||
1228 | <value>The location to the external annotation file associated with the document. Default value is **null**.</value> |
||
1229 | </member>
|
||
1230 | <member name="P:Leadtools.Documents.LoadDocumentOptions.Cache"> |
||
1231 | <summary>The cache to use with the new document.</summary> |
||
1232 | <value>The cache to use with the new document. Default value is **null**.</value> |
||
1233 | </member>
|
||
1234 | <member name="P:Leadtools.Documents.LoadDocumentOptions.CacheOptions"> |
||
1235 | <summary>Determines which part of the document will be stored in the cache.</summary> |
||
1236 | <value>Determines which part of the document will be stored in the cache. Default value is DocumentCacheOptions.None.</value> |
||
1237 | </member>
|
||
1238 | <member name="P:Leadtools.Documents.LoadDocumentOptions.CachePolicy"> |
||
1239 | <summary>The cache policy to use with the new document.</summary> |
||
1240 | <value>The cache policy to use for the new document that determine when the document and its parts are purged. Default value is</value> |
||
1241 | </member>
|
||
1242 | <member name="P:Leadtools.Documents.LoadDocumentOptions.DocumentId"> |
||
1243 | <summary>The ID to be used with the loaded document.</summary> |
||
1244 | <value>String that specifies the ID to be used with the loaded document. Default value is **null**.</value> |
||
1245 | </member>
|
||
1246 | <member name="P:Leadtools.Documents.LoadDocumentOptions.FirstPageNumber"> |
||
1247 | <summary>Number of the first page to be loaded from the document.</summary> |
||
1248 | <value>The 1-based number of the first page to be converted from the input document. Default value is 0.</value> |
||
1249 | </member>
|
||
1250 | <member name="P:Leadtools.Documents.LoadDocumentOptions.LastPageNumber"> |
||
1251 | <summary>Number of the last page to be loaded from the document.</summary> |
||
1252 | <value>The 1-based number of the last page to be converted from the input document. Default value is 0.</value> |
||
1253 | </member>
|
||
1254 | <member name="P:Leadtools.Documents.LoadDocumentOptions.LoadEmbeddedAnnotations"> |
||
1255 | <summary>Indicates whether to try to load the annotations embedded in the document itself.</summary> |
||
1256 | <value>**true** to try to load the annotations embedded in the document, otherwise; **false**. Default</value> |
||
1257 | </member>
|
||
1258 | <member name="P:Leadtools.Documents.LoadDocumentOptions.MaximumImagePixelSize"> |
||
1259 | <summary>Maximum width or height in pixels to use when obtaining image data from the pages in this document.</summary> |
||
1260 | <value>The maximum width or height in pixels to use when obtaining image data from the pages in this document. Default value is 0 which means to use the original size.</value> |
||
1261 | </member>
|
||
1262 | <member name="P:Leadtools.Documents.LoadDocumentOptions.MayHaveDifferentPageSizes"> |
||
1263 | <summary>Hint to the loader that the document may contain pages with different size.</summary> |
||
1264 | <value>**true** if the document may contain pages with different size, otherwise; **false**. Default value is **false**.</value> |
||
1265 | </member>
|
||
1266 | <member name="P:Leadtools.Documents.LoadDocumentOptions.MimeType"> |
||
1267 | <summary>The optional mime type of the document being loaded.</summary> |
||
1268 | <value>Optional mime type of the document being loaded. The default value is **null**.</value> |
||
1269 | </member>
|
||
1270 | <member name="P:Leadtools.Documents.LoadDocumentOptions.Name"> |
||
1271 | <summary>Optional name of the document.</summary> |
||
1272 | <value>The optional name of the document.</value> |
||
1273 | </member>
|
||
1274 | <member name="P:Leadtools.Documents.LoadDocumentOptions.Password"> |
||
1275 | <summary>The password to use if the document is encrypted.</summary> |
||
1276 | <value>The password to use if the document is encrypted. Default value is **null**.</value> |
||
1277 | </member>
|
||
1278 | <member name="P:Leadtools.Documents.LoadDocumentOptions.UseCache"> |
||
1279 | <summary>Indicates whether the new document will use the cache system.</summary> |
||
1280 | <value>**true** if the new document will use the cache system, otherwise; **false**. Default value is **false**.</value> |
||
1281 | </member>
|
||
1282 | <member name="P:Leadtools.Documents.LoadDocumentOptions.WebClient"> |
||
1283 | <summary>The .NET System.Net.WebClient object to use when downloading or uploading data from a remote URL.</summary> |
||
1284 | <value>The .NET System.Net.WebClient object to use when downloading or uploading data from a remote URL. Default value is **null**.</value> |
||
1285 | </member>
|
||
1286 | <member name="T:Leadtools.Documents.SaveDocumentOptions"> |
||
1287 | <summary>Options to use when saving a document.</summary> |
||
1288 | </member>
|
||
1289 | <member name="M:Leadtools.Documents.SaveDocumentOptions.#ctor"> |
||
1290 | <summary>Initializes a new instance of SaveDocumentOptions with default parameters.</summary> |
||
1291 | </member>
|
||
1292 | <member name="P:Leadtools.Documents.SaveDocumentOptions.AnnotationsUri"> |
||
1293 | <summary>Path to where the annotations file will be saved.</summary> |
||
1294 | <value>The path to where the annotations file will be saved. Default value is **null**.</value> |
||
1295 | </member>
|
||
1296 | <member name="P:Leadtools.Documents.SaveDocumentOptions.BitsPerPixel"> |
||
1297 | <summary>Bits per pixel to use when saving the document.</summary> |
||
1298 | <value>The bits per pixel to use when saving the document. Default value is 0.</value> |
||
1299 | </member>
|
||
1300 | <member name="P:Leadtools.Documents.SaveDocumentOptions.Format"> |
||
1301 | <summary>Raster image format to use when saving the document.</summary> |
||
1302 | <value>The raster image format to use when saving the document. Default value is RasterImageFormat.Unknown.</value> |
||
1303 | </member>
|
||
1304 | <member name="P:Leadtools.Documents.SaveDocumentOptions.WebClient"> |
||
1305 | <summary>The .NET System.Net.WebClient object to use when downloading or uploading data from a remote URL.</summary> |
||
1306 | <value>The .NET System.Net.WebClient object to use when downloading or uploading data from a remote URL. Default value is **null**.</value> |
||
1307 | </member>
|
||
1308 | <member name="T:Leadtools.Documents.UploadDocumentOptions"> |
||
1309 | <summary>Options to use when uploading a document to the cache.</summary> |
||
1310 | </member>
|
||
1311 | <member name="M:Leadtools.Documents.UploadDocumentOptions.#ctor"> |
||
1312 | <summary>Initializes a new instance of UploadDocumentOptions with default parameters.</summary> |
||
1313 | </member>
|
||
1314 | <member name="P:Leadtools.Documents.UploadDocumentOptions.Cache"> |
||
1315 | <summary>The cache to use with the new document.</summary> |
||
1316 | <value>The cache to use with the new document. Default value is **null**.</value> |
||
1317 | </member>
|
||
1318 | <member name="P:Leadtools.Documents.UploadDocumentOptions.CachePolicy"> |
||
1319 | <summary>The cache policy to use with the new document.</summary> |
||
1320 | <value>The cache policy to use for the new document that determine when the document and its parts are purged. Default value is</value> |
||
1321 | </member>
|
||
1322 | <member name="P:Leadtools.Documents.UploadDocumentOptions.DocumentId"> |
||
1323 | <summary>The ID to be used with the loaded document.</summary> |
||
1324 | <value>String that specifies the ID to be used with the loaded document. Default value is **null**.</value> |
||
1325 | </member>
|
||
1326 | <member name="T:Leadtools.Documents.DocumentCacheOptions"> |
||
1327 | <summary>Determines which extra parts of the document will be stroed in the cache.</summary> |
||
1328 | </member>
|
||
1329 | <member name="F:Leadtools.Documents.DocumentCacheOptions.None"> |
||
1330 | <summary>No extra parts of the document is cached. Only what is needed to re-construct the documents and its pages from the cache.</summary> |
||
1331 | </member>
|
||
1332 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageImage"> |
||
1333 | <summary>Calls to DocumentPage.GetImage will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1334 | </member>
|
||
1335 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageSvg"> |
||
1336 | <summary>Calls to DocumentPage.GetSvg will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1337 | </member>
|
||
1338 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageSvgBackImage"> |
||
1339 | <summary>Calls to DocumentPage.GetSvgBackImage will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1340 | </member>
|
||
1341 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageThumbnailImage"> |
||
1342 | <summary>Calls to DocumentPage.GetThumbnailImage will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1343 | </member>
|
||
1344 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageText"> |
||
1345 | <summary>Calls to DocumentPage.GetText will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1346 | </member>
|
||
1347 | <member name="F:Leadtools.Documents.DocumentCacheOptions.PageAnnotations"> |
||
1348 | <summary>Calls to DocumentPage.GetAnnotations will try to save the result in the cache and re-used in subsequent calls.</summary> |
||
1349 | </member>
|
||
1350 | <member name="F:Leadtools.Documents.DocumentCacheOptions.All"> |
||
1351 | <summary>All results are cached and re-used in subsequent calls.</summary> |
||
1352 | </member>
|
||
1353 | <member name="T:Leadtools.Documents.DocumentCacheStatus"> |
||
1354 | <summary>The status of this document in the cache.</summary> |
||
1355 | </member>
|
||
1356 | <member name="F:Leadtools.Documents.DocumentCacheStatus.Synced"> |
||
1357 | <summary>The document is synced and no saving to cache is required.</summary> |
||
1358 | </member>
|
||
1359 | <member name="F:Leadtools.Documents.DocumentCacheStatus.NotSynced"> |
||
1360 | <summary>The document is not synced and saving to cache is required.</summary> |
||
1361 | </member>
|
||
1362 | <member name="T:Leadtools.Documents.DocumentFontStyles"> |
||
1363 | <summary>Font style.</summary> |
||
1364 | </member>
|
||
1365 | <member name="F:Leadtools.Documents.DocumentFontStyles.Normal"> |
||
1366 | <summary></summary> |
||
1367 | </member>
|
||
1368 | <member name="F:Leadtools.Documents.DocumentFontStyles.Bold"> |
||
1369 | <summary></summary> |
||
1370 | </member>
|
||
1371 | <member name="F:Leadtools.Documents.DocumentFontStyles.Italic"> |
||
1372 | <summary></summary> |
||
1373 | </member>
|
||
1374 | <member name="F:Leadtools.Documents.DocumentFontStyles.Underline"> |
||
1375 | <summary></summary> |
||
1376 | </member>
|
||
1377 | <member name="T:Leadtools.Documents.DocumentLinkType"> |
||
1378 | <summary>Type of a document link object.</summary> |
||
1379 | </member>
|
||
1380 | <member name="F:Leadtools.Documents.DocumentLinkType.Value"> |
||
1381 | <summary>Use DocumentLink.Value. The link target is an external value.</summary> |
||
1382 | </member>
|
||
1383 | <member name="F:Leadtools.Documents.DocumentLinkType.TargetPage"> |
||
1384 | <summary>Use DocumentLink.Target.</summary> |
||
1385 | </member>
|
||
1386 | <member name="T:Leadtools.Documents.DocumentPageFitType"> |
||
1387 | <summary>Specifies how to fit the page when an internal link is invoked.</summary> |
||
1388 | </member>
|
||
1389 | <member name="F:Leadtools.Documents.DocumentPageFitType.None"> |
||
1390 | <summary>No fitting. Use Position and ZoomPercent if they have valid values.</summary> |
||
1391 | </member>
|
||
1392 | <member name="F:Leadtools.Documents.DocumentPageFitType.Fit"> |
||
1393 | <summary>Show the whole page in the view. If the page is smaller, do not zoom in.</summary> |
||
1394 | </member>
|
||
1395 | <member name="F:Leadtools.Documents.DocumentPageFitType.FitAlways"> |
||
1396 | <summary>Show the whole page in the view. If the page is smaller, zoom in to fit.</summary> |
||
1397 | </member>
|
||
1398 | <member name="F:Leadtools.Documents.DocumentPageFitType.FitWidth"> |
||
1399 | <summary>Fit the view so the whole width of the page is visible.</summary> |
||
1400 | </member>
|
||
1401 | <member name="F:Leadtools.Documents.DocumentPageFitType.FitHeight"> |
||
1402 | <summary>Fit the view so the whole height of the page is visible.</summary> |
||
1403 | </member>
|
||
1404 | <member name="T:Leadtools.Documents.DocumentTextExtractionMode"> |
||
1405 | <summary>Mode to use when extracting text from this document.</summary> |
||
1406 | </member>
|
||
1407 | <member name="F:Leadtools.Documents.DocumentTextExtractionMode.Auto"> |
||
1408 | <summary>Automatic. This depends on the document type, if it supports SVG, then SVG is used; otherwise, if available use OCR.</summary> |
||
1409 | </member>
|
||
1410 | <member name="F:Leadtools.Documents.DocumentTextExtractionMode.SvgOnly"> |
||
1411 | <summary>Use SVG only if the document supports it. Otherwise, do not extract text.</summary> |
||
1412 | </member>
|
||
1413 | <member name="F:Leadtools.Documents.DocumentTextExtractionMode.OcrOnly"> |
||
1414 | <summary>Use OCR always even if the document supports SVG.</summary> |
||
1415 | </member>
|
||
1416 | <member name="T:Leadtools.Documents.DocumentCharacter"> |
||
1417 | <summary>Contains the properties of a text character found in the page.</summary> |
||
1418 | </member>
|
||
1419 | <member name="P:Leadtools.Documents.DocumentCharacter.Bounds"> |
||
1420 | <summary>The bounding rectangle of the character.</summary> |
||
1421 | <value>The bounding rectangle of the character in document coordinates. Default value is empty rectangle.</value> |
||
1422 | </member>
|
||
1423 | <member name="P:Leadtools.Documents.DocumentCharacter.Code"> |
||
1424 | <summary>The character code value of this DocumentCharacter.</summary> |
||
1425 | <value>The character code value of this DocumentCharacter. Default value is 0.</value> |
||
1426 | </member>
|
||
1427 | <member name="P:Leadtools.Documents.DocumentCharacter.IsEndOfLine"> |
||
1428 | <summary>Indicates if this the last character in a line.</summary> |
||
1429 | <value>**true** if this is the last character in a line; otherwise, it is **false**. The default value is **false**.</value> |
||
1430 | </member>
|
||
1431 | <member name="P:Leadtools.Documents.DocumentCharacter.IsEndOfWord"> |
||
1432 | <summary>Indicates if this the last character in a word.</summary> |
||
1433 | <value>**true** if this is the last character in a word; otherwise, it is **false**. The default value is **false**.</value> |
||
1434 | </member>
|
||
1435 | <member name="P:Leadtools.Documents.DocumentCharacter.IsLineBreak"> |
||
1436 | <summary>Indicates whether this character has a soft line break.</summary> |
||
1437 | <value>**true** if this character has a soft line break; otherwise, **false**.</value> |
||
1438 | </member>
|
||
1439 | <member name="P:Leadtools.Documents.DocumentCharacter.IsRightToLeft"> |
||
1440 | <summary>Indicates if this character is part of a right to left flow of text.</summary> |
||
1441 | <value>**true** if this character is part of a right to left flow of text, otherwise; **false**.</value> |
||
1442 | </member>
|
||
1443 | <member name="T:Leadtools.Documents.DocumentLink"> |
||
1444 | <summary>Holds the properties of a link inside the document.</summary> |
||
1445 | </member>
|
||
1446 | <member name="M:Leadtools.Documents.DocumentLink.Clone"> |
||
1447 | <summary>Returns an extact clone of this object.</summary> |
||
1448 | <returns>Extact clone of this object.</returns> |
||
1449 | </member>
|
||
1450 | <member name="P:Leadtools.Documents.DocumentLink.Bounds"> |
||
1451 | <summary>Link location and position in the page.</summary> |
||
1452 | <value>The link location and position in the page in document coordinates. Default value is empty rectangle.</value> |
||
1453 | </member>
|
||
1454 | <member name="P:Leadtools.Documents.DocumentLink.LinkType"> |
||
1455 | <summary>Link type.</summary> |
||
1456 | <value>The link type. Default value is DocumentLinkType.Value.</value> |
||
1457 | </member>
|
||
1458 | <member name="P:Leadtools.Documents.DocumentLink.Target"> |
||
1459 | <summary>Target properties if this is an internal link.</summary> |
||
1460 | <value>The target properties if this is an internal link. Default value is a default DocumentLinkTarget structure.</value> |
||
1461 | </member>
|
||
1462 | <member name="P:Leadtools.Documents.DocumentLink.Value"> |
||
1463 | <summary>Value if this is an external link.</summary> |
||
1464 | <value>The value of the external link. Default value is **null**.</value> |
||
1465 | </member>
|
||
1466 | <member name="T:Leadtools.Documents.DocumentLinkTarget"> |
||
1467 | <summary>Defines the target of an internal link in the document.</summary> |
||
1468 | </member>
|
||
1469 | <member name="M:Leadtools.Documents.DocumentLinkTarget.Clone"> |
||
1470 | <summary>Returns an extact clone of this object.</summary> |
||
1471 | <returns>Extact clone of this object.</returns> |
||
1472 | </member>
|
||
1473 | <member name="P:Leadtools.Documents.DocumentLinkTarget.PageFitType"> |
||
1474 | <summary>Indicates how to fit the target page.</summary> |
||
1475 | <value>A value that indicate how to fit the target page. Default value is DocumentPageFitType.None.</value> |
||
1476 | </member>
|
||
1477 | <member name="P:Leadtools.Documents.DocumentLinkTarget.PageNumber"> |
||
1478 | <summary>Target page number.</summary> |
||
1479 | <value>The 1-based target page number. Default value is 0.</value> |
||
1480 | </member>
|
||
1481 | <member name="P:Leadtools.Documents.DocumentLinkTarget.Position"> |
||
1482 | <summary>Target position to use after moving to the page.</summary> |
||
1483 | <value>The target position to use after moving to the page in document coordinates. Default value is 0,0.</value> |
||
1484 | </member>
|
||
1485 | <member name="P:Leadtools.Documents.DocumentLinkTarget.ZoomPercent"> |
||
1486 | <summary>Zoom percentage to use after moving to the page.</summary> |
||
1487 | <value>The zoom percentage to use after moving to the page. Default value is 0.</value> |
||
1488 | </member>
|
||
1489 | <member name="T:Leadtools.Documents.DocumentWord"> |
||
1490 | <summary>Contains the properties of a text word found in the page.</summary> |
||
1491 | </member>
|
||
1492 | <member name="P:Leadtools.Documents.DocumentWord.Bounds"> |
||
1493 | <summary>The bounding rectangle of the word.</summary> |
||
1494 | <value>The bounding word of the character in document coordinates. Default value is empty rectangle.</value> |
||
1495 | </member>
|
||
1496 | <member name="P:Leadtools.Documents.DocumentWord.FirstCharacterIndex"> |
||
1497 | <summary>The index of the first character that forms this word in the Characters list.</summary> |
||
1498 | <value>The 0-based index of the first character that forms this word in the Characters list. Default value is **0**.</value> |
||
1499 | </member>
|
||
1500 | <member name="P:Leadtools.Documents.DocumentWord.LastCharacterIndex"> |
||
1501 | <summary>The index of the last character that forms this word in the Characters list.</summary> |
||
1502 | <value>The 0-based index of the last character that forms this word in the Characters list. Default value is **0**.</value> |
||
1503 | </member>
|
||
1504 | <member name="P:Leadtools.Documents.DocumentWord.Value"> |
||
1505 | <summary>The string value of the word.</summary> |
||
1506 | <value>The string value of the word. Default value is **null**.</value> |
||
1507 | </member>
|
||
1508 | </members>
|
||
1509 | </doc> |