Skip to content

Commit d969b39

Browse files
committed
Update WebTwain_Util.md
1 parent 44303b2 commit d969b39

File tree

1 file changed

+64
-40
lines changed

1 file changed

+64
-40
lines changed

info/api/WebTwain_Util.md

Lines changed: 64 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ The properties and methods on this page live in the namespace {WebTwainObject}.
3030

3131
## isUsingActiveX
3232

33+
Return whether the WebTwain object is running the ActiveX edition.
34+
3335
**Syntax**
3436

3537
```typescript
36-
/**
37-
* Return whether the WebTwain object is running the ActiveX edition.
38-
*/
3938
isUsingActiveX(): boolean;
4039
```
4140

4241
**Availability**
42+
4343
<div class="availability">
4444
<table>
4545

@@ -66,18 +66,22 @@ isUsingActiveX(): boolean;
6666

6767
## RegisterEvent
6868

69+
Specify an event listener for the specified built-in event.
70+
6971
**Syntax**
7072

7173
```typescript
72-
/**
73-
* Specify an event listener for the specified built-in event.
74-
* @param name Specify the event
75-
* @param callback The event listener
76-
*/
7774
RegisterEvent(name: string, callback: () => void): boolean;
7875
```
7976

77+
**Parameters**
78+
79+
`name`: Specify the event.
80+
81+
`callback`: The event listener.
82+
8083
**Availability**
84+
8185
<div class="availability">
8286
<table>
8387

@@ -104,18 +108,22 @@ RegisterEvent(name: string, callback: () => void): boolean;
104108

105109
## UnregisterEvent
106110

111+
Remove an event listener from the specified built-in event.
112+
107113
**Syntax**
108114

109115
```typescript
110-
/**
111-
* Remove an event listener from the specified built-in event.
112-
* @param name Specify the event
113-
* @param callback The event listener
114-
*/
115116
UnregisterEvent(name: string, callback: () => void): boolean;
116117
```
117118

119+
**Parameters**
120+
121+
`name`: Specify the event.
122+
123+
`callback`: The event listener.
124+
118125
**Availability**
126+
119127
<div class="availability">
120128
<table>
121129

@@ -146,19 +154,22 @@ There can only be one listener for each built-in event. If you call `RegisterEve
146154

147155
## SetLanguage
148156

157+
Set the language for the authorization dialogs.
158+
149159
**Syntax**
150160

151161
```typescript
152-
/**
153-
* Set the language for the authorization dialogs.
154-
* @param language Specify the language.
155-
*/
156162
SetLanguage(
157163
language: Dynamsoft.DWT.EnumDWT_Language | number
158164
): boolean;
159165
```
160166

167+
**Parameters**
168+
169+
`language`: Specify the language. Please refer to [EnumDWT_Language]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_language)
170+
161171
**Availability**
172+
162173
<div class="availability">
163174
<table>
164175

@@ -189,11 +200,13 @@ The language set with this method is only for the built-in security dialogs whic
189200

190201
## GenerateURLForUploadData
191202

203+
Generate a URL to be used by a FileUpoader instance to fetch the data to upload.
204+
192205
**Syntax**
193206

194207
```typescript
195208
/**
196-
* Generate a URL to be used by a FileUpoader instance to fetch the data to upload.
209+
*
197210
* @param indices Specify the images to upload.
198211
* @param type Specify the file type.
199212
* @param successCallback A callback function that is executed if the request succeeds.
@@ -217,7 +230,23 @@ GenerateURLForUploadData(
217230
): void;
218231
```
219232

233+
**Parameters**
234+
235+
`indices`: Specify the images to upload.
236+
237+
`type`: Specify the file type. Please refer to [EnumDWT_ImageType]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_imagetype).
238+
239+
`successCallback`: A callback function that is executed if the request succeeds.
240+
- `resultURL`: The generated URL.
241+
- `indices`: The indices of the images.
242+
- `type`: The file type. Please refer to [EnumDWT_ImageType]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_imagetype).
243+
244+
`failureCallback`: A callback function that is executed if the request fails.
245+
- `errorCode`: The error code.
246+
- `errorString`: The error string.
247+
220248
**Availability**
249+
221250
<div class="availability">
222251
<table>
223252

@@ -244,16 +273,16 @@ GenerateURLForUploadData(
244273

245274
## ErrorCode
246275

276+
Return the error code.
277+
247278
**Syntax**
248279

249280
```typescript
250-
/**
251-
* Return the error code.
252-
*/
253281
readonly ErrorCode: number;
254282
```
255283

256284
**Availability**
285+
257286
<div class="availability">
258287
<table>
259288

@@ -284,16 +313,16 @@ The `ErrorCode` and `ErrorString` always reflect the result of the last API call
284313

285314
## ErrorString
286315

316+
Return the error string.
317+
287318
**Syntax**
288319

289320
```typescript
290-
/**
291-
* Return the error string.
292-
*/
293321
readonly ErrorString: string;
294322
```
295323

296324
**Availability**
325+
297326
<div class="availability">
298327
<table>
299328

@@ -324,12 +353,11 @@ The `ErrorCode` and `ErrorString` always reflect the result of the last API call
324353

325354
## LogLevel
326355

356+
Return or set the log level for debugging.
357+
327358
**Syntax**
328359

329360
```typescript
330-
/**
331-
* Return or set the log level for debugging.
332-
*/
333361
LogLevel: number;
334362
```
335363

@@ -359,18 +387,17 @@ LogLevel: number;
359387

360388
**Usage notes**
361389

362-
The logs for the Dynamic Web TWAIN library are saved in the directory `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\log\`. By default, `LogLevel` is 0 and nothing is recorded. When it is set to 1, all debugging information is recorded. This setting in your application will apply to all machines.
390+
The logs for the Dynamic Web TWAIN library are saved in the directory `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\log\`. By default, `LogLevel` is 0 and nothing is recorded. When it is set to 1, all debugging information is recorded. This setting in your application will apply to all machines. Please set it back to 0 if you don't need to record log as it will slow down the speed.
363391

364392
---
365393

366394
## Manufacturer
367395

396+
Manufacturer in the identity string of the Dynamic Web TWAIN library.
397+
368398
**Syntax**
369399

370400
```typescript
371-
/**
372-
* Manufacturer in the identity string of the Dynamic Web TWAIN library.
373-
*/
374401
readonly Manufacturer: string;
375402
```
376403

@@ -406,12 +433,11 @@ readonly Manufacturer: string;
406433

407434
## ProductFamily
408435

436+
ProductFamily in the identity string of the Dynamic Web TWAIN library.
437+
409438
**Syntax**
410439

411440
```typescript
412-
/**
413-
* ProductFamily in the identity string of the Dynamic Web TWAIN library.
414-
*/
415441
readonly ProductFamily: string;
416442
```
417443

@@ -447,12 +473,11 @@ readonly ProductFamily: string;
447473

448474
## ProductName
449475

476+
ProductName in the identity string of the Dynamic Web TWAIN library.
477+
450478
**Syntax**
451479

452480
```typescript
453-
/**
454-
* ProductName in the identity string of the Dynamic Web TWAIN library.
455-
*/
456481
readonly ProductName: string;
457482
```
458483

@@ -488,12 +513,11 @@ readonly ProductName: string;
488513

489514
## VersionInfo
490515

516+
VersionInfo in the identity string of the Dynamic Web TWAIN library.
517+
491518
**Syntax**
492519

493520
```typescript
494-
/**
495-
* VersionInfo in the identity string of the Dynamic Web TWAIN library.
496-
*/
497521
readonly VersionInfo: string;
498522
```
499523

0 commit comments

Comments
 (0)