Skip to content

Commit 1a601e7

Browse files
committed
Docs update
1 parent ede574d commit 1a601e7

File tree

6 files changed

+97
-4
lines changed

6 files changed

+97
-4
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: EndLineMatchingBehavior
3+
parent: Enumerations
4+
grand_parent: API
5+
nav_order: 2
6+
---
7+
8+
# EndLineMatchingBehavior Enum
9+
{: .fs-9 }
10+
11+
Provides the list of supported behaviors for matching line breaks in the buffer.
12+
{: .fs-6 .fw-300 }
13+
14+
---
15+
16+
## Parts
17+
18+
|**_Constant_**|**_Member name_**|
19+
|:----------|:----------|
20+
|0|*OnlyBackwardSense*|
21+
|1|*Bidirectional*|
22+
23+
---
24+
25+
## Syntax
26+
27+
*variable* = `EndLineMatchingBehavior`.*Constant*
28+
29+
>📝**Note**
30+
>{: .text-grey-lt-000 .bg-green-000 }
31+
>The `EndLineMatchingBehavior` enumeration is used to specify the method for finding line breaks over chunks obtained from the current text file.
32+
{: .text-grey-dk-300 .bg-grey-lt-000 }
33+
34+
See also
35+
: [LinebreakMatchingBehavior Property](https://ws-garcia.github.io/ECPTextStream/api/properties/linebreakmatchingbehavior.html)
36+
37+
[Back to Enumerations overview](https://ws-garcia.github.io/ECPTextStream/api/enumerations/)

docs/api/properties/buffersize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>The `bufferSize` enable user to specify how many data is read at a time. By default, the `bufferSize` property is set to 0.5 MB. For files holding very long lines, user must to choose a size enough to hold couple of lines at once.
41+
>The `bufferSize` enables user to specify how many data is read at a time. By default, the `bufferSize` property is set to 0.5 MB. For files holding very long lines, user must to choose a size enough to hold couple of lines at once.
4242
{: .text-grey-dk-300 .bg-grey-lt-000 }
4343

4444
See also
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: linebreakMatchingBehavior
3+
parent: Properties
4+
grand_parent: API
5+
nav_order: 8
6+
---
7+
8+
# linebreakMatchingBehavior
9+
{: .d-inline-block }
10+
11+
New
12+
{: .label .label-purple }
13+
14+
Gets or sets the behavior of line break matching in subsequent text stream operations.
15+
{: .fs-6 .fw-300 }
16+
17+
---
18+
19+
## ReadWrite
20+
21+
_Yes_
22+
23+
---
24+
25+
## Syntax
26+
27+
|**_Accesor_**|**_Syntax_**|
28+
|:----------|:----------|
29+
|Get|*expression*.`linebreakMatchingBehavior`|
30+
|Let|*expression*.`linebreakMatchingBehavior` = value|
31+
32+
|**_Accesor_**|**_Parameters_**|
33+
|:----------|:----------|
34+
|Get|_None_|
35+
|Let|*Name*: Value<br>*Type*: `EndLineMatchingBehavior`<br>*Modifiers*: `ByVal`|
36+
37+
|**_Accesor_**|**_Returns Type_**|
38+
|:----------|:----------|
39+
|Get|`EndLineMatchingBehavior`|
40+
|Let|_None_|
41+
42+
## Behavior
43+
44+
The `linebreakMatchingBehavior` property allows the user to specify how line breaks are searched for to end the current buffer in vbCrLf, vbCr or vbLf as specified in the `endStreamOnLineBreak` property. By default, the `linebreakMatchingBehavior` property is set to `EndLineMatchingBehavior.Bidirectional`, this option ensures the handling of files with long lines that cannot be contained in a string of specified size as in the `bufferSize` property.
45+
46+
>⚠️**Caution**
47+
>{: .text-grey-lt-000 .bg-green-000 }
48+
>Setting the `linebreakMatchingBehavior` property to `EndLineMatchingBehavior.OnlyBackwardSense` may cause unexpected behavior when the stream is requested to end at a line break and the current text stream contains a portion of a long line that cannot be stored in the specified buffer size.
49+
{: .text-grey-dk-300 .bg-yellow-000 }
50+
51+
See also
52+
: [EndStreamOnLineBreak Property](https://ws-garcia.github.io/ECPTextStream/api/properties/endstreamonlinebreak.html), [EndLineMatchingBehavior Enumeration](https://ws-garcia.github.io/ECPTextStream/api/enumerations/endlinematchingbehavior.html), [BufferSize Property](https://ws-garcia.github.io/ECPTextStream/api/properties/buffersize.html).
53+
54+
---
55+
56+
[Back to Properties overview](https://ws-garcia.github.io/ECPTextStream/api/properties/)

docs/api/properties/pointerposition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: pointerPosition
33
parent: Properties
44
grand_parent: API
5-
nav_order: 8
5+
nav_order: 9
66
---
77

88
# pointerPosition

docs/api/properties/streamlength.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: streamLength
33
parent: Properties
44
grand_parent: API
5-
nav_order: 9
5+
nav_order: 10
66
---
77

88
# streamLength

docs/api/properties/unifiedlfoutput.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: unifiedLFOutput
33
parent: Properties
44
grand_parent: API
5-
nav_order: 10
5+
nav_order: 11
66
---
77

88
# unifiedLFOutput

0 commit comments

Comments
 (0)