Skip to content

Commit

Permalink
C++ API Reference 24.10
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderMalokhovetskiy committed Oct 17, 2024
1 parent e8fd2ce commit 112a93a
Show file tree
Hide file tree
Showing 231 changed files with 1,603 additions and 208 deletions.
1 change: 1 addition & 0 deletions english/cpp/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ is_root: true
| [Aspose::Pdf::Drawing](./aspose.pdf.drawing/) | |
| [Aspose::Pdf::Facades](./aspose.pdf.facades/) | |
| [Aspose::Pdf::Forms](./aspose.pdf.forms/) | |
| [Aspose::Pdf::Generator](./aspose.pdf.generator/) | |
| [Aspose::Pdf::GroupProcessor](./aspose.pdf.groupprocessor/) | |
| [Aspose::Pdf::GroupProcessor::Creators](./aspose.pdf.groupprocessor.creators/) | |
| [Aspose::Pdf::LogicalStructure](./aspose.pdf.logicalstructure/) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class CaretAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| Method | Description |
| --- | --- |
| [Accept](./accept/)(System::SharedPtr\<AnnotationSelector\>) override | Accepts visitor object to process the annotation. |
| [CaretAnnotation](./caretannotation/)(System::SharedPtr\<Document\>) | Constructor for usign in Generator. |
| [CaretAnnotation](./caretannotation/)(System::SharedPtr\<Document\>) | Constructor for usign in [Generator](../../aspose.pdf.generator/). |
| [CaretAnnotation](./caretannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>) | Creates new Caret annotation on the specified page. |
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [get_Frame](./get_frame/)() | Gets caret rectangle. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Aspose::Pdf::Annotations::CaretAnnotation::CaretAnnotation(System::SharedPtr<Asp
## CaretAnnotation::CaretAnnotation(System::SharedPtr\<Document\>) constructor
Constructor for usign in Generator.
Constructor for usign in [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::CaretAnnotation::CaretAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class CommonFigureAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| Method | Description |
| --- | --- |
| [CommonFigureAnnotation](./commonfigureannotation/)(System::SharedPtr\<Document\>) | Constructor for using in Generator. |
| [CommonFigureAnnotation](./commonfigureannotation/)(System::SharedPtr\<Document\>) | Constructor for using in [Generator](../../aspose.pdf.generator/). |
| [get_Frame](./get_frame/)() | The rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square or circle. |
| [get_InteriorColor](./get_interiorcolor/)() | Interior color with which to fill the annotation's rectangle or ellipse. |
| [set_Frame](./set_frame/)(System::SharedPtr\<Rectangle\>) | The rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square or circle. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ url: /cpp/aspose.pdf.annotations/commonfigureannotation/commonfigureannotation/
## CommonFigureAnnotation::CommonFigureAnnotation constructor


Constructor for using in Generator.
Constructor for using in [Generator](../../../aspose.pdf.generator/).

```cpp
Aspose::Pdf::Annotations::CommonFigureAnnotation::CommonFigureAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class FreeTextAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| Method | Description |
| --- | --- |
| [Accept](./accept/)(System::SharedPtr\<AnnotationSelector\>) override | Accepts visitor object to process the annotation. |
| [FreeTextAnnotation](./freetextannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<Aspose::Pdf::Annotations::DefaultAppearance\>) | Constructor to use with Generator. |
| [FreeTextAnnotation](./freetextannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<Aspose::Pdf::Annotations::DefaultAppearance\>) | Constructor to use with [Generator](../../aspose.pdf.generator/). |
| [FreeTextAnnotation](./freetextannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>, System::SharedPtr\<Aspose::Pdf::Annotations::DefaultAppearance\>) | Creates new FreeText annotation on the specified page. |
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [get_Callout](./get_callout/)() | Array of point specifying callout line. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Aspose::Pdf::Annotations::FreeTextAnnotation::FreeTextAnnotation(System::SharedP
## FreeTextAnnotation::FreeTextAnnotation(System::SharedPtr\<Document\>, System::SharedPtr\<Aspose::Pdf::Annotations::DefaultAppearance\>) constructor
Constructor to use with Generator.
Constructor to use with [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::FreeTextAnnotation::FreeTextAnnotation(System::SharedPtr<Document> document, System::SharedPtr<Aspose::Pdf::Annotations::DefaultAppearance> appearance)
Expand Down
2 changes: 1 addition & 1 deletion english/cpp/aspose.pdf.annotations/inkannotation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class InkAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [get_CapStyle](./get_capstyle/)() | Style of ink annotation line endings. |
| [get_InkList](./get_inklist/)() | Gets list of gestures that are independent lines which are represented by [Point](../../aspose.pdf/point/)[] arrays. |
| [InkAnnotation](./inkannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<System::Collections::Generic::IList\<System::ArrayPtr\<System::SharedPtr\<Point\>\>\>\>) | Constructor for Ink annotation for Generator. |
| [InkAnnotation](./inkannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<System::Collections::Generic::IList\<System::ArrayPtr\<System::SharedPtr\<Point\>\>\>\>) | Constructor for Ink annotation for [Generator](../../aspose.pdf.generator/). |
| [InkAnnotation](./inkannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>, System::SharedPtr\<System::Collections::Generic::IList\<System::ArrayPtr\<System::SharedPtr\<Point\>\>\>\>) | Creates new Ink annotation on the specified page. |
| [set_CapStyle](./set_capstyle/)(Aspose::Pdf::Annotations::CapStyle) | Style of ink annotation line endings. |
| [set_InkList](./set_inklist/)(System::SharedPtr\<System::Collections::Generic::IList\<System::ArrayPtr\<System::SharedPtr\<Point\>\>\>\>) | Sets list of gestures that are independent lines which are represented by [Point](../../aspose.pdf/point/)[] arrays. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Aspose::Pdf::Annotations::InkAnnotation::InkAnnotation(System::SharedPtr<Aspose:
## InkAnnotation::InkAnnotation(System::SharedPtr\<Document\>, System::SharedPtr\<System::Collections::Generic::IList\<System::ArrayPtr\<System::SharedPtr\<Point\>\>\>\>) constructor
Constructor for Ink annotation for Generator.
Constructor for Ink annotation for [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::InkAnnotation::InkAnnotation(System::SharedPtr<Document> document, System::SharedPtr<System::Collections::Generic::IList<System::ArrayPtr<System::SharedPtr<Point>>>> inkList)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class LineAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| [get_ShowCaption](./get_showcaption/)() | Gets boolean flag which determinies is contents must be shown as caption. |
| [get_Starting](./get_starting/)() | Gets starting point of line. |
| [get_StartingStyle](./get_startingstyle/)() | Gets line ending style for line starting point. |
| [LineAnnotation](./lineannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<Point\>, System::SharedPtr\<Point\>) | Constructor for using with Generator. |
| [LineAnnotation](./lineannotation/)(System::SharedPtr\<Document\>, System::SharedPtr\<Point\>, System::SharedPtr\<Point\>) | Constructor for using with [Generator](../../aspose.pdf.generator/). |
| [LineAnnotation](./lineannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>, System::SharedPtr\<Point\>, System::SharedPtr\<Point\>) | Creates new Line annotation on the specified page. |
| [set_CaptionOffset](./set_captionoffset/)(System::SharedPtr\<Point\>) | Sets caption text offset from its normal position. |
| [set_CaptionPosition](./set_captionposition/)(Aspose::Pdf::Annotations::CaptionPosition) | Sets annotation caption position. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Aspose::Pdf::Annotations::LineAnnotation::LineAnnotation(System::SharedPtr<Aspos
## LineAnnotation::LineAnnotation(System::SharedPtr\<Document\>, System::SharedPtr\<Point\>, System::SharedPtr\<Point\>) constructor
Constructor for using with Generator.
Constructor for using with [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::LineAnnotation::LineAnnotation(System::SharedPtr<Document> document, System::SharedPtr<Point> start, System::SharedPtr<Point> end)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class MovieAnnotation : public Aspose::Pdf::Annotations::Annotation,
| [get_Poster](./get_poster/)() | Gets a flag or stream specifying whether and how a poster image representing the movie shall be displayed. If true, the poster image shall be retrieved from the movie file; if it is false, no poster shall be displayed. |
| [get_Rotate](./get_rotate/)() | Gets the number of degrees by which the movie shall be rotated clockwise relative to the page. The value shall be a multiple of 90. |
| [get_Title](./get_title/)() override | Gets the title of the movie annotation. |
| [MovieAnnotation](./movieannotation/)(System::SharedPtr\<Document\>, System::String) | Constructor for using with Generator. |
| [MovieAnnotation](./movieannotation/)(System::SharedPtr\<Document\>, System::String) | Constructor for using with [Generator](../../aspose.pdf.generator/). |
| [MovieAnnotation](./movieannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>, System::String) | Creates new Sound annotation on the specified page. |
| [set_Aspect](./set_aspect/)(System::SharedPtr\<Point\>) | Sets the width and height of the movie's bounding box, in pixels. |
| [set_File](./set_file/)(System::SharedPtr\<FileSpecification\>) | Sets a file specification identifying a self-describing movie file. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Aspose::Pdf::Annotations::MovieAnnotation::MovieAnnotation(System::SharedPtr<Asp
## MovieAnnotation::MovieAnnotation(System::SharedPtr\<Document\>, System::String) constructor
Constructor for using with Generator.
Constructor for using with [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::MovieAnnotation::MovieAnnotation(System::SharedPtr<Document> document, System::String movieFile)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class PolygonAnnotation : public Aspose::Pdf::Annotations::PolyAnnotation
| --- | --- |
| [Accept](./accept/)(System::SharedPtr\<AnnotationSelector\>) override | Accepts visitor object for annotation processing. |
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [PolygonAnnotation](./polygonannotation/)(System::SharedPtr\<Document\>, System::ArrayPtr\<System::SharedPtr\<Point\>\>) | Constructor for using with Generator. |
| [PolygonAnnotation](./polygonannotation/)(System::SharedPtr\<Document\>, System::ArrayPtr\<System::SharedPtr\<Point\>\>) | Constructor for using with [Generator](../../aspose.pdf.generator/). |
| [PolygonAnnotation](./polygonannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>, System::ArrayPtr\<System::SharedPtr\<Point\>\>) | Creates new Polygon annotation on the specified page. |
## See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Aspose::Pdf::Annotations::PolygonAnnotation::PolygonAnnotation(System::SharedPtr
## PolygonAnnotation::PolygonAnnotation(System::SharedPtr\<Document\>, System::ArrayPtr\<System::SharedPtr\<Point\>\>) constructor
Constructor for using with Generator.
Constructor for using with [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::PolygonAnnotation::PolygonAnnotation(System::SharedPtr<Document> document, System::ArrayPtr<System::SharedPtr<Point>> vertices)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class PopupAnnotation : public Aspose::Pdf::Annotations::Annotation
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [get_Open](./get_open/)() | Gets a flag specifying whether the pop-up annotation should initially be displayed open. |
| [get_Parent](./get_parent/)() | Gets the parent annotation with which this pop-up annotation shall be associated. If this entry is present, the parent annotation's Contents, M, C, and T entries shall override those of the pop-up annotation itself. |
| [PopupAnnotation](./popupannotation/)(System::SharedPtr\<Document\>) | Constructor. for using in Generator. |
| [PopupAnnotation](./popupannotation/)(System::SharedPtr\<Document\>) | Constructor. for using in [Generator](../../aspose.pdf.generator/). |
| [PopupAnnotation](./popupannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>) | Creates new Popup annotation on the specified page. |
| [set_Open](./set_open/)(bool) | Sets a flag specifying whether the pop-up annotation should initially be displayed open. |
| [set_Parent](./set_parent/)(System::SharedPtr\<Annotation\>) | Sets the parent annotation with which this pop-up annotation shall be associated. If this entry is present, the parent annotation's Contents, M, C, and T entries shall override those of the pop-up annotation itself. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Aspose::Pdf::Annotations::PopupAnnotation::PopupAnnotation(System::SharedPtr<Asp
## PopupAnnotation::PopupAnnotation(System::SharedPtr\<Document\>) constructor
Constructor. for using in Generator.
Constructor. for using in [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::PopupAnnotation::PopupAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class RedactionAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| [get_Repeat](./get_repeat/)() | If true overlay text will be repated on the annotation. |
| [get_TextAlignment](./get_textalignment/)() | Gets. Alignment of Overlay [Text](../../aspose.pdf.text/). |
| [Redact](./redact/)() | Flattens annotation and redacts page contents (i.e. removes text and image under redacted annotation) |
| [RedactionAnnotation](./redactionannotation/)(System::SharedPtr\<Document\>) | Constructor for [RedactionAnnotation](./). For using in Generator. |
| [RedactionAnnotation](./redactionannotation/)(System::SharedPtr\<Document\>) | Constructor for [RedactionAnnotation](./). For using in [Generator](../../aspose.pdf.generator/). |
| [RedactionAnnotation](./redactionannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>) | Constructor for RedactAnnotation. |
| [set_BorderColor](./set_bordercolor/)(System::SharedPtr\<Aspose::Pdf::Color\>) | Sets color of border which is drawn when redaction is not active. |
| [set_DefaultAppearance](./set_defaultappearance/)(System::String) | Sets the default appearance string to be used in formatting the text. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Aspose::Pdf::Annotations::RedactionAnnotation::RedactionAnnotation(System::Share
## RedactionAnnotation::RedactionAnnotation(System::SharedPtr\<Document\>) constructor
Constructor for [RedactionAnnotation](../). For using in Generator.
Constructor for [RedactionAnnotation](../). For using in [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::RedactionAnnotation::RedactionAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class SquareAnnotation : public Aspose::Pdf::Annotations::CommonFigureAnnotation
| --- | --- |
| [Accept](./accept/)(System::SharedPtr\<AnnotationSelector\>) override | Accepts visitor to process annotation. |
| [get_AnnotationType](./get_annotationtype/)() override | Gets type of annotation. |
| [SquareAnnotation](./squareannotation/)(System::SharedPtr\<Document\>) | Constructor for using with Generator. |
| [SquareAnnotation](./squareannotation/)(System::SharedPtr\<Document\>) | Constructor for using with [Generator](../../aspose.pdf.generator/). |
| [SquareAnnotation](./squareannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>) | Creates new Square annotation on the specified page. |
## See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Aspose::Pdf::Annotations::SquareAnnotation::SquareAnnotation(System::SharedPtr<A
## SquareAnnotation::SquareAnnotation(System::SharedPtr\<Document\>) constructor
Constructor for using with Generator.
Constructor for using with [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::SquareAnnotation::SquareAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class TextAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
| [get_Open](./get_open/)() | Gets a flag specifying whether the annotation should initially be displayed open. |
| [set_Icon](./set_icon/)(TextIcon) | Sets an icon to be used in displaying the annotation. |
| [set_Open](./set_open/)(bool) | Sets a flag specifying whether the annotation should initially be displayed open. |
| [TextAnnotation](./textannotation/)(System::SharedPtr\<Document\>) | Constructor for annotation when used in Generator. |
| [TextAnnotation](./textannotation/)(System::SharedPtr\<Document\>) | Constructor for annotation when used in [Generator](../../aspose.pdf.generator/). |
| [TextAnnotation](./textannotation/)(System::SharedPtr\<Aspose::Pdf::Page\>, System::SharedPtr\<Rectangle\>) | Creates new [Text](../../aspose.pdf.text/) annotation on the specified page. |
## See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Aspose::Pdf::Annotations::TextAnnotation::TextAnnotation(System::SharedPtr<Aspos
## TextAnnotation::TextAnnotation(System::SharedPtr\<Document\>) constructor
Constructor for annotation when used in Generator.
Constructor for annotation when used in [Generator](../../../aspose.pdf.generator/).
```cpp
Aspose::Pdf::Annotations::TextAnnotation::TextAnnotation(System::SharedPtr<Document> document)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class WidgetAnnotation : public Aspose::Pdf::Annotations::Annotation
| [set_OnActivated](./set_onactivated/)(System::SharedPtr\<PdfAction\>) | An action which shall be performed when the annotation is activated. |
| [set_ReadOnly](./set_readonly/)(bool) | Sets read only status of the field. |
| [set_Required](./set_required/)(bool) | Sets required status of the field. |
| [WidgetAnnotation](./widgetannotation/)(System::SharedPtr\<Document\>) | Create annotation (used for Generator) |
| [WidgetAnnotation](./widgetannotation/)(System::SharedPtr\<Document\>) | Create annotation (used for [Generator](../../aspose.pdf.generator/)) |
## See Also
* Class [Annotation](../annotation/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ url: /cpp/aspose.pdf.annotations/widgetannotation/widgetannotation/
## WidgetAnnotation::WidgetAnnotation constructor


Create annotation (used for Generator)
Create annotation (used for [Generator](../../../aspose.pdf.generator/))

```cpp
Aspose::Pdf::Annotations::WidgetAnnotation::WidgetAnnotation(System::SharedPtr<Document> doc)
Expand Down
1 change: 1 addition & 0 deletions english/cpp/aspose.pdf.drawing/arc/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class Arc : public Aspose::Pdf::Drawing::Shape
| Method | Description |
| --- | --- |
| [Arc](./arc/)(float, float, float, float, float) | Initializes a new instance of the [Arc](./) class. |
| [CheckBounds](./checkbounds/)(double, double) override | Checks if the item fits within the given container dimensions (inclusive). |
| [get_Alpha](./get_alpha/)() const | Gets a float value that indicates the beginning angle degree of the arc. |
| [get_Beta](./get_beta/)() const | Gets a float value that indicates the ending angle degree of the arc. |
| [get_PosX](./get_posx/)() const | Gets a float value that indicates the x-coordinate of the center of the arc. |
Expand Down
Loading

0 comments on commit 112a93a

Please sign in to comment.