Bookmark.h
1 #pragma once
2 // Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.
3 
4 #include <system/string.h>
5 #include <drawing/color.h>
6 #include <cstdint>
7 
8 #include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"
9 
10 namespace Aspose
11 {
12 namespace Pdf
13 {
14 namespace Annotations
15 {
16 class ExplicitDestination;
17 } // namespace Annotations
18 class ApsToPdfConverter;
19 class Document;
20 namespace Facades
21 {
22 class Bookmarks;
23 class PdfBookmarkEditor;
24 } // namespace Facades
25 class OutlineItemCollection;
26 class Page;
27 } // namespace Pdf
28 } // namespace Aspose
29 
30 namespace Aspose {
31 
32 namespace Pdf {
33 
34 namespace Facades {
35 
39 class ASPOSE_PDF_SHARED_CLASS Bookmark final : public System::Object
40 {
41  typedef Bookmark ThisType;
42  typedef System::Object BaseType;
43 
44  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
45  ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
46 
47  friend class Aspose::Pdf::ApsToPdfConverter;
50 
51 public:
52 
58  ASPOSE_PDF_SHARED_API System::String get_Action() const;
64  ASPOSE_PDF_SHARED_API void set_Action(System::String value);
68  ASPOSE_PDF_SHARED_API bool get_BoldFlag() const;
72  ASPOSE_PDF_SHARED_API void set_BoldFlag(bool value);
77  ASPOSE_PDF_SHARED_API System::SharedPtr<Bookmarks> get_ChildItem();
82  ASPOSE_PDF_SHARED_API void set_ChildItem(System::SharedPtr<Bookmarks> value);
86  ASPOSE_PDF_SHARED_API System::SharedPtr<Bookmarks> get_ChildItems() const;
90  ASPOSE_PDF_SHARED_API void set_ChildItems(System::SharedPtr<Bookmarks> value);
94  ASPOSE_PDF_SHARED_API System::String get_Destination() const;
98  ASPOSE_PDF_SHARED_API void set_Destination(System::String value);
102  ASPOSE_PDF_SHARED_API bool get_ItalicFlag() const;
106  ASPOSE_PDF_SHARED_API void set_ItalicFlag(bool value);
110  ASPOSE_PDF_SHARED_API int32_t get_Level() const;
114  ASPOSE_PDF_SHARED_API void set_Level(int32_t value);
118  ASPOSE_PDF_SHARED_API System::String get_PageDisplay() const;
122  ASPOSE_PDF_SHARED_API void set_PageDisplay(System::String value);
126  ASPOSE_PDF_SHARED_API int32_t get_PageDisplay_Bottom() const;
130  ASPOSE_PDF_SHARED_API void set_PageDisplay_Bottom(int32_t value);
134  ASPOSE_PDF_SHARED_API int32_t get_PageDisplay_Left() const;
138  ASPOSE_PDF_SHARED_API void set_PageDisplay_Left(int32_t value);
142  ASPOSE_PDF_SHARED_API int32_t get_PageDisplay_Right() const;
146  ASPOSE_PDF_SHARED_API void set_PageDisplay_Right(int32_t value);
150  ASPOSE_PDF_SHARED_API int32_t get_PageDisplay_Top() const;
154  ASPOSE_PDF_SHARED_API void set_PageDisplay_Top(int32_t value);
158  ASPOSE_PDF_SHARED_API int32_t get_PageDisplay_Zoom() const;
162  ASPOSE_PDF_SHARED_API void set_PageDisplay_Zoom(int32_t value);
166  ASPOSE_PDF_SHARED_API int32_t get_PageNumber() const;
170  ASPOSE_PDF_SHARED_API void set_PageNumber(int32_t value);
174  ASPOSE_PDF_SHARED_API System::String get_RemoteFile() const;
178  ASPOSE_PDF_SHARED_API void set_RemoteFile(System::String value);
182  ASPOSE_PDF_SHARED_API System::String get_Title() const;
186  ASPOSE_PDF_SHARED_API void set_Title(System::String value);
190  ASPOSE_PDF_SHARED_API System::Drawing::Color get_TitleColor() const;
194  ASPOSE_PDF_SHARED_API void set_TitleColor(System::Drawing::Color value);
198  ASPOSE_PDF_SHARED_API bool get_Open() const;
202  ASPOSE_PDF_SHARED_API void set_Open(bool value);
203 
207  ASPOSE_PDF_SHARED_API Bookmark();
208 
209  ASPOSE_PDF_SHARED_API int32_t CompareTo(const System::SharedPtr<Bookmark>& value);
210 
211 protected:
212 
215 
216 private:
217 
218  System::String action;
219  bool bold;
220  System::SharedPtr<Bookmarks> childItems;
221  bool italic;
222  System::String destination;
223  int32_t level;
224  System::String pageDisplayMode;
225  int32_t pageNumber;
226  System::String remoteFile;
227  System::String title;
229  int32_t left;
230  int32_t bottom;
231  int32_t right;
232  int32_t top;
233  int32_t zoom;
234  bool open;
235 
238 
239 };
240 
241 } // namespace Facades
242 } // namespace Pdf
243 } // namespace Aspose
244 
245 
String class used across the library. Is a substitute for C# System.String when translating code...
Definition: string.h:121
Base class that enables using methods available for System.Object class in C#. All non-trivial classe...
Definition: object.h:64
Represents a class to work with PDF file&#39;s bookmarks including create, modify, export, import and delete.
Definition: PdfBookmarkEditor.h:53
Represents a bookmark.
Definition: Bookmark.h:39
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: fwd.h:22
Definition: AFRelationship.h:4
Represents a color. This type should be allocated on stack and passed to functions by value or by ref...
Definition: color.h:23
The coordinates are in the page coordinate context.
Represents a collection of Bookmark objects.
Definition: Bookmarks.h:27
Whole PDF file will be submitted.