Skip to content

Commit

Permalink
C++ API Reference with non static fields
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderMalokhovetskiy committed Sep 23, 2024
1 parent 5993acf commit 5f5db14
Show file tree
Hide file tree
Showing 224 changed files with 3,250 additions and 60 deletions.
5 changes: 5 additions & 0 deletions english/cpp/aspose.pdf.forms/form/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ class Form : public System::Collections::Generic::ICollection<System::SharedPtr<
| [set_SignaturesAppendOnly](./set_signaturesappendonly/)(bool) | If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update. |
| [set_SignaturesExist](./set_signaturesexist/)(bool) | If set, the document contains at least one signature field. |
| [set_Type](./set_type/)(FormType) | Gets type of the form. Possible values are: Standard, Static, Dynamic. |
## Fields
| Field | Description |
| --- | --- |
| [SignDependentElementsRenderingModeWhenConverted](./signdependentelementsrenderingmodewhenconverted/) | [Forms](../) can contain signing information, i.e. can be signed or unsigned. And form's view sometimes must depend on whether form is signed or not. This property tells to form's converter (f.e. during conversion [XFA](../xfa/) form to Standard form) whether result form must be rendered as signed or as unsigned. |
## See Also
* Class [ICollection](../../system.collections.generic/icollection/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: FlattenSettings
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Forms::Form::FlattenSettings class. Class which describes settings for Form flattening procedure in C++.'
type: docs
weight: 3900
weight: 4000
url: /cpp/aspose.pdf.forms/form/flattensettings/
---
## FlattenSettings class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: SignDependentElementsRenderingModes
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Forms::Form::SignDependentElementsRenderingModes enum. Forms can contain signing information and can be signed or unsigned. Sometimes view of forms in viewer must depend on whether form is signed or not. This enum enumerates possible rendering modes during convertion of form type in regard to sign in C++.'
type: docs
weight: 3800
weight: 3900
url: /cpp/aspose.pdf.forms/form/signdependentelementsrenderingmodes/
---
## SignDependentElementsRenderingModes enum
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::Forms::Form::SignDependentElementsRenderingModeWhenConverted field
linktitle: SignDependentElementsRenderingModeWhenConverted
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Forms::Form::SignDependentElementsRenderingModeWhenConverted field. Forms can contain signing information, i.e. can be signed or unsigned. And form''s view sometimes must depend on whether form is signed or not. This property tells to form''s converter (f.e. during conversion XFA form to Standard form) whether result form must be rendered as signed or as unsigned in C++.'
type: docs
weight: 3800
url: /cpp/aspose.pdf.forms/form/signdependentelementsrenderingmodewhenconverted/
---
## SignDependentElementsRenderingModeWhenConverted field


[Forms](../../) can contain signing information, i.e. can be signed or unsigned. And form's view sometimes must depend on whether form is signed or not. This property tells to form's converter (f.e. during conversion [XFA](../../xfa/) form to Standard form) whether result form must be rendered as signed or as unsigned.

```cpp
Form::SignDependentElementsRenderingModes Aspose::Pdf::Forms::Form::SignDependentElementsRenderingModeWhenConverted
```

## See Also

* Class [Form](../)
* Namespace [Aspose::Pdf::Forms](../../)
* Library [Aspose.PDF for C++](../../../)
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ class MarkdownSaveOptions : public Aspose::Pdf::UnifiedSaveOptions
| [set_ResourcesDirectoryName](./set_resourcesdirectoryname/)(System::String) | Gets and sets the directory name to save document resources such as images. If the value is not specified, then the images will be written to the same directory as the markdown file itself. This is not path, it is only name! This directory will be automatically created in the directory with the saved markdown file. |
| [set_SubscriptAndSuperscriptConversion](./set_subscriptandsuperscriptconversion/)(bool) | Gets ans sets allowance to convert subscript and superscript. This value is true by default. |
| [set_UseImageHtmlTag](./set_useimagehtmltag/)(bool) | Gets and sets allowance to use of an img tag to insert images to the left and right of the text. In this case, in the markdown viewer, the text will wrap around the image. |
## Fields
| Field | Description |
| --- | --- |
| [IsMultiThreading](../../aspose.pdf/unifiedsaveoptions/ismultithreading/) | Process pages in few threads. |
| [TryMergeAdjacentSameBackgroundImages](../../aspose.pdf/unifiedsaveoptions/trymergeadjacentsamebackgroundimages/) | Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. |
## See Also
* Class [UnifiedSaveOptions](../../aspose.pdf/unifiedsaveoptions/)
Expand Down
6 changes: 6 additions & 0 deletions english/cpp/aspose.pdf.text/textfragmentstate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ class TextFragmentState : public Aspose::Pdf::Text::TextState
| [set_Underline](./set_underline/)(bool) override | Sets underline for the text, represented by the [TextFragment](../textfragment/) object. |
| [set_WordSpacing](./set_wordspacing/)(float) override | Sets word spacing of the text. |
| [TextFragmentState](./textfragmentstate/)(System::SharedPtr\<TextFragment\>) | Initializes new instance of the [TextFragmentState](./) object with specified [TextFragment](../textfragment/) object. This [TextFragmentState](./) initialization is not supported. [TextFragmentState](./) is only available with [TextFragment::TextState](../) property. |
## Fields
| Field | Description |
| --- | --- |
| [TabstopDefaultValue](../textstate/tabstopdefaultvalue/) | Default value of tabulation in widths of space character of default font. |
| [TabTag](../textstate/tabtag/) | You can place this tag in text to declare tabulation. |
## Remarks
Expand Down
6 changes: 6 additions & 0 deletions english/cpp/aspose.pdf.text/textstate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ class TextState : public System::Object
| [TextState](./textstate/)(System::String) | Creates text state object with font family specification. |
| [TextState](./textstate/)(System::String, bool, bool) | Creates text state object with font family and font style specification. |
| [TextState](./textstate/)(System::String, double) | Creates text state object with font family and font size specification. |
## Fields
| Field | Description |
| --- | --- |
| [TabstopDefaultValue](./tabstopdefaultvalue/) | Default value of tabulation in widths of space character of default font. |
| [TabTag](./tabtag/) | You can place this tag in text to declare tabulation. |
## See Also
* Class [Object](../../system/object/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::Text::TextState::TabstopDefaultValue field
linktitle: TabstopDefaultValue
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Text::TextState::TabstopDefaultValue field. Default value of tabulation in widths of space character of default font in C++.'
type: docs
weight: 4100
url: /cpp/aspose.pdf.text/textstate/tabstopdefaultvalue/
---
## TabstopDefaultValue field


Default value of tabulation in widths of space character of default font.

```cpp
float Aspose::Pdf::Text::TextState::TabstopDefaultValue
```

## See Also

* Class [TextState](../)
* Namespace [Aspose::Pdf::Text](../../)
* Library [Aspose.PDF for C++](../../../)
27 changes: 27 additions & 0 deletions english/cpp/aspose.pdf.text/textstate/tabtag/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Aspose::Pdf::Text::TextState::TabTag field
linktitle: TabTag
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Text::TextState::TabTag field. You can place this tag in text to declare tabulation in C++.'
type: docs
weight: 4200
url: /cpp/aspose.pdf.text/textstate/tabtag/
---
## TabTag field


You can place this tag in text to declare tabulation.

```cpp
System::String Aspose::Pdf::Text::TextState::TabTag
```

## Remarks


It has effect only in couple with [TabStops](../../tabstops/).
## See Also

* Class [TextState](../)
* Namespace [Aspose::Pdf::Text](../../)
* Library [Aspose.PDF for C++](../../../)
6 changes: 6 additions & 0 deletions english/cpp/aspose.pdf.text/unicodesubstitution/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ class UnicodeSubstitution : public System::Object,
| --- | --- |
| [UnicodeSubstitution](./unicodesubstitution/)(char16_t, char16_t) | Creates character code substitution struct. |
| [UnicodeSubstitution](./unicodesubstitution/)() | |
## Fields
| Field | Description |
| --- | --- |
| [OriginalCode](./originalcode/) | Represents original character unicode. |
| [SubstitutionCode](./substitutioncode/) | Represents character unicode that substitutes original unicode. |
## Remarks
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::Text::UnicodeSubstitution::OriginalCode field
linktitle: OriginalCode
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Text::UnicodeSubstitution::OriginalCode field. Represents original character unicode in C++.'
type: docs
weight: 200
url: /cpp/aspose.pdf.text/unicodesubstitution/originalcode/
---
## OriginalCode field


Represents original character unicode.

```cpp
char16_t Aspose::Pdf::Text::UnicodeSubstitution::OriginalCode
```

## See Also

* Class [UnicodeSubstitution](../)
* Namespace [Aspose::Pdf::Text](../../)
* Library [Aspose.PDF for C++](../../../)
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::Text::UnicodeSubstitution::SubstitutionCode field
linktitle: SubstitutionCode
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Text::UnicodeSubstitution::SubstitutionCode field. Represents character unicode that substitutes original unicode in C++.'
type: docs
weight: 300
url: /cpp/aspose.pdf.text/unicodesubstitution/substitutioncode/
---
## SubstitutionCode field


Represents character unicode that substitutes original unicode.

```cpp
char16_t Aspose::Pdf::Text::UnicodeSubstitution::SubstitutionCode
```

## See Also

* Class [UnicodeSubstitution](../)
* Namespace [Aspose::Pdf::Text](../../)
* Library [Aspose.PDF for C++](../../../)
6 changes: 6 additions & 0 deletions english/cpp/aspose.pdf/apssaveoptions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ class ApsSaveOptions : public Aspose::Pdf::UnifiedSaveOptions
| Method | Description |
| --- | --- |
| [ApsSaveOptions](./apssaveoptions/)() | Constructor of APsSaveOptions class. |
## Fields
| Field | Description |
| --- | --- |
| [IsMultiThreading](../unifiedsaveoptions/ismultithreading/) | Process pages in few threads. |
| [TryMergeAdjacentSameBackgroundImages](../unifiedsaveoptions/trymergeadjacentsamebackgroundimages/) | Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. |
## See Also
* Class [UnifiedSaveOptions](../unifiedsaveoptions/)
Expand Down
7 changes: 7 additions & 0 deletions english/cpp/aspose.pdf/docsaveoptions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ class DocSaveOptions : public Aspose::Pdf::UnifiedSaveOptions,
| [set_RecognizeBullets](./set_recognizebullets/)(bool) | Switch on the recognition of bullets. |
| [set_RelativeHorizontalProximity](./set_relativehorizontalproximity/)(float) | In [Pdf](../) words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document. |
| [set_ReSaveFonts](./set_resavefonts/)(bool) | Sets the procedure for resaving fonts. If set to true, we reload fonts on every page to avoid the influence of previous font properties and load the newly created font from scratch. Set this option to false if you want to improve performance. The default value is true;. |
## Fields
| Field | Description |
| --- | --- |
| [CustomProgressHandler](./customprogresshandler/) | This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is : |
| [IsMultiThreading](../unifiedsaveoptions/ismultithreading/) | Process pages in few threads. |
| [TryMergeAdjacentSameBackgroundImages](../unifiedsaveoptions/trymergeadjacentsamebackgroundimages/) | Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. |
## See Also
* Class [UnifiedSaveOptions](../unifiedsaveoptions/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::DocSaveOptions::CustomProgressHandler field
linktitle: CustomProgressHandler
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::DocSaveOptions::CustomProgressHandler field. This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler''s code that shows progress on console is : in C++.'
type: docs
weight: 2600
url: /cpp/aspose.pdf/docsaveoptions/customprogresshandler/
---
## CustomProgressHandler field


This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is :

```cpp
UnifiedSaveOptions::ConversionProgressEventHandler Aspose::Pdf::DocSaveOptions::CustomProgressHandler
```

## See Also

* Class [DocSaveOptions](../)
* Namespace [Aspose::Pdf](../../)
* Library [Aspose.PDF for C++](../../../)
2 changes: 1 addition & 1 deletion english/cpp/aspose.pdf/docsaveoptions/docformat/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: DocFormat
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::DocSaveOptions::DocFormat enum. Allows to specify .doc or .docx file format in C++.'
type: docs
weight: 2600
weight: 2700
url: /cpp/aspose.pdf/docsaveoptions/docformat/
---
## DocFormat enum
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: RecognitionMode
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::DocSaveOptions::RecognitionMode enum. Allows to control how a PDF document is converted into a word processing document in C++.'
type: docs
weight: 2700
weight: 2800
url: /cpp/aspose.pdf/docsaveoptions/recognitionmode/
---
## RecognitionMode enum
Expand Down
1 change: 1 addition & 0 deletions english/cpp/aspose.pdf/document/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ class Document : public System::IDisposable,
| Field | Description |
| --- | --- |
| static [DefaultNodesNumInSubtrees](./defaultnodesnuminsubtrees/) | |
| [FontSubstitution](./fontsubstitution/) | Occurs when font replaces another font in document. |
## Typedefs
| Typedef | Description |
Expand Down
2 changes: 1 addition & 1 deletion english/cpp/aspose.pdf/document/callbackgethocr/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: CallBackGetHocr
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::CallBackGetHocr typedef. The call back procedure for hocr recognize in C++.'
type: docs
weight: 11900
weight: 12000
url: /cpp/aspose.pdf/document/callbackgethocr/
---
## CallBackGetHocr typedef
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: CallBackGetHocrWithPage
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::CallBackGetHocrWithPage typedef. The call back procedure for hocr recognize in C++.'
type: docs
weight: 12000
weight: 12100
url: /cpp/aspose.pdf/document/callbackgethocrwithpage/
---
## CallBackGetHocrWithPage typedef
Expand Down
23 changes: 23 additions & 0 deletions english/cpp/aspose.pdf/document/fontsubstitution/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Aspose::Pdf::Document::FontSubstitution field
linktitle: FontSubstitution
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::FontSubstitution field. Occurs when font replaces another font in document in C++.'
type: docs
weight: 11900
url: /cpp/aspose.pdf/document/fontsubstitution/
---
## FontSubstitution field


Occurs when font replaces another font in document.

```cpp
System::Event<void(System::SharedPtr<Text::Font>, System::SharedPtr<Text::Font>)> Aspose::Pdf::Document::FontSubstitution
```

## See Also

* Class [Document](../)
* Namespace [Aspose::Pdf](../../)
* Library [Aspose.PDF for C++](../../../)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: FontSubstitutionHandler
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::FontSubstitutionHandler typedef. Represents the method that will handle FontSubstitution event in C++.'
type: docs
weight: 12100
weight: 12200
url: /cpp/aspose.pdf/document/fontsubstitutionhandler/
---
## FontSubstitutionHandler typedef
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: IDocumentFontUtilities
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::IDocumentFontUtilities class. Holds functionality to tune fonts in C++.'
type: docs
weight: 12200
weight: 12300
url: /cpp/aspose.pdf/document/idocumentfontutilities/
---
## IDocumentFontUtilities class
Expand Down
2 changes: 1 addition & 1 deletion english/cpp/aspose.pdf/document/mergeoptions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: MergeOptions
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::MergeOptions class. Represents the options to Merge methods in C++.'
type: docs
weight: 12300
weight: 12400
url: /cpp/aspose.pdf/document/mergeoptions/
---
## MergeOptions class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: OptimizationOptions
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::OptimizationOptions class. Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method in C++.'
type: docs
weight: 12400
weight: 12500
url: /cpp/aspose.pdf/document/optimizationoptions/
---
## OptimizationOptions class
Expand Down
2 changes: 1 addition & 1 deletion english/cpp/aspose.pdf/document/repairoptions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: RepairOptions
second_title: Aspose.PDF for C++ API Reference
description: 'Aspose::Pdf::Document::RepairOptions class. Represents options for repairing a PDF document in C++.'
type: docs
weight: 12500
weight: 12600
url: /cpp/aspose.pdf/document/repairoptions/
---
## RepairOptions class
Expand Down
Loading

0 comments on commit 5f5db14

Please sign in to comment.