HelpNDoc User Manual
71 / 87
function GetCustomSettingValue(const aCustomSetting: string): Variant;
Returns the user-defined value of a custom setting.
property AssetsList: TStringList read FAssetsList write FAssetsList;
List of assets files from the template.
property CurrentBuildId: string read FCurrentBuildId write FCurrentBuildId;
Current build Id being executed.
property CurrentTopic: string read FCurrentTopic write SetCurrentTopic;
Current topic ID which is being worked on.
property GeneratedFiles: TStringList read FGeneratedFiles write FGeneratedFiles;
List of files that have been generated so far.
property TemplateInfo: THndTemplateInfo read FTemplateInfo write FTemplateInfo;
Information about the currently used template.
function GetItemMetaRawValue(const aKey: string): WideString; override;
Returns the raw IROStrings value for the property of the specified item.
procedure SetItemMetaRawValue(const aKey: string; const aRawValue: WideString); override;
Assign a raw value to a specific key.
procedure AddSearchData(const aSearchData, aAssociatedTopicId: string);
Add search data and associate it to a specific topic.
procedure ClearSearchData;
Clear the current search data.
function GetJsData: string;
Get the Javascript search data.
Array of minimal keyword information
function CreateKeyword: string;
Create a new keyword. The new keyword will be placed at the bottom of the list.
procedure DeleteAllKeywords;
Delete all the keywords in the project, except the root project keyword.
function DeleteKeyword(const aKeywordId: string): Boolean;
Delete a specific keyword and its children.
function GenerateUniqueCaption(const aBaseCaption, aParentId: string; const
aFilteredItems: array of string): string;
Generates a unique caption within the specified parent.
function GetKeywordByCaption(aCaption, aParentId: string): string;
Returns the ID of the keyword with the specified case-insensitive caption with the specified
function GetKeywordCaption(const aKeywordId: string): string;
Get the caption of a specific keyword.
function GetKeywordDirectChildrenCount(const aKeywordId: string): Integer;
Convert pdf to powerpoint online for - SDK application API:C# Create PDF from PowerPoint Library to convert pptx, ppt to PDF in, ASP.NET MVC, WinForms, WPF
Online C# Tutorial for Creating PDF from Microsoft PowerPoint Presentation
Convert pdf to powerpoint online for - SDK application API:VB.NET Create PDF from PowerPoint Library to convert pptx, ppt to PDF in, ASP.NET MVC, WinForms, WPF
VB.NET Tutorial for Export PDF file from Microsoft Office PowerPoint
HelpNDoc User Manual
72 / 87
Returns the number of children for the speicified keyword.
function GetKeywordDirectChildrenList(const aParentId: string): THndKeywordsInfoArray;
Returns a list of all the children keywords.
function GetKeywordLevel(const aKeywordId: string): Integer;
Returns the level of the specified keyword.
function GetKeywordList(const aIncludingProjectKeyword: Boolean = False):
Returns a list of all the keywords.
function GetKeywordNext(const aKeywordId: string): string;
Get the next keyword in line. Could be a child or the next keyword.
function GetKeywordNextSibbling(const aKeywordId: string): string;
Returns the next sibbling of a specific keyword.
function GetKeywordParent(const aKeywordId: string): string;
Returns the parent keyword of a specific keyword.
function GetKeywordPreviousSibbling(const aKeywordId: string): string;
Get the previous sibbling keyword.
function GetProjectKeyword: string;
Returns the root project keyword.
function MoveKeyword(const aKeywordId, aReferencedKeywordId: string; const oAttachMode:
THndKeywordsAttachMode): Boolean;
Move the keyword to a new position in reference to nReferencedKeywordsId.
function MoveKeywordLeft(const aKeywordId: string): Boolean;
Move the specific keyword left in the hierarchy.
function MoveKeywordRight(const aKeywordId: string): Boolean;
Move the specific keyword right in the hierarchy.
procedure SetCurrentKeyword(const aKeywordId: string);
Set the DB pointer to the specified keyword.
function SetKeywordCaption(const aKeywordId, sNewCaption: string): string;
Defines the specific keyword' caption.
Array of minimal library item information
function CreateItem: string;
Creates a new unspecified item to the library.
function DeleteItem(const anItemId: string): Boolean;
Delete a specific library item.
function GetItemByCaption(const aCaption: string): string;
Returns the item with the given caption.
function GetItemCaption(const anItemId: string): string;
Gets the caption of a specific item.
function GetItemContent(const anItemId: string): TMemoryStream;
Get the content of the item as a stream. Caller must free the stream after using it.
SDK application API:Online Convert PowerPoint to PDF file. Best free online export
Online Powerpoint to PDF Converter. Download Free Trial. Convert a PPTX/PPT File to PDF. Just upload your file by clicking on the blue
SDK application API:VB.NET PDF - Convert PDF Online with VB.NET HTML5 PDF Viewer
RasterEdge. PRODUCTS: ONLINE DEMOS: Online HTML5 Document Viewer; Online XDoc.PDF Word to PDF; Convert Excel to PDF; Convert PowerPoint to PDF; Convert Image
HelpNDoc User Manual
73 / 87
function GetItemContentAsText(const anItemId: string): string;
Get the content of an item as a text.
function GetItemContentChecksum(const anItemId: string): string;
Returns the checksum (MD5) of a library item content. Useful for comparison purposes.
function GetItemExtension(const anItemId: string): string;
Get the item's file extension.
function GetItemKind(const anItemId: string): Integer;
Gets the kind of the specific item.
function GetItemList(aIncludingKinds: array of Integer): THndLibraryItemsInfoArray;
Returns a list of items filtered by aIncludingKinds.
function GetItemParent(const anItemId: string): string;
Returns the parent item of a specific item.
function GetItemSource(const anItemId: string): Integer;
Gets the source of a specific library item.
function GetItemsWithSameContent(const anItemId: string; const aFilteredItems: array of
string): THndLibraryItemsInfoArray;
Returns the items with the same content as the specified one.
function GetItemUrlFile(const anItemId: string): string;
Sets the URL File of a specified library item.
function GetItemUrlFileAbsolute(const anItemId: string): string;
Gets the URL of a specified library item: use project path if relative.
function GetItemUrlLink(const anItemId: string): string;
Sets the URL Link of a specified library item.
function GetProjectItem: string;
Returns the root project library item.
function MoveItem(const anItemId, aReferencedItemId: string; const oAttachMode:
THndLibraryItemAttachMode): Boolean;
Move the library item to a new position in reference to aReferencedItemId.
function SetItemCaption(const anItemId, aCaption: string): string;
Sets the caption of a specific item.
function SetItemContent(const anItemId: string; const aContent: TStream): Boolean;
Sets the content stream of a specified item.
function SetItemContentFromFile(const anItemId, aContentFile: string): Boolean;
Set the content of the item from an existing file.
function SetItemContentFromText(const anItemId, aContentText: string): Boolean;
Sets the content as text of a specific item.
function SetItemExtension(const anItemId, anExtension: string): Boolean;
Set the item's file extension.
function SetItemKind(const anItemId: string; const aKind: Integer): Boolean;
Sets the kind of a specific item.
function SetItemSource(const anItemId: string; const aSource: Integer): Boolean;
Sets the source of a specific library item.
SDK application API:C# HTML5 PDF Viewer SDK to convert and export PDF document to
RasterEdge. PRODUCTS: ONLINE DEMOS: Online HTML5 Document Viewer; Online XDoc.PDF Word to PDF; Convert Excel to PDF; Convert PowerPoint to PDF; Convert Image
SDK application API:XDoc.HTML5 Viewer for .NET, Zero Footprint AJAX Document Image
View, Convert, Edit, Sign Documents and Images. Online Demo See the HTML5 Viewer SDK for .NET in powerful & profession imaging controls, PDF document, image to
HelpNDoc User Manual
74 / 87
function SetItemUrlFile(const anItemId, anUrlFile: string): Boolean;
Sets the URL File of a specified library item.
function SetItemUrlLink(const anItemId, anUrlLink: string): Boolean;
Sets the URL Link of a specified library item.
procedure AddOrInvalidateItem(anItemId: string);
Add an item to the cache or invalidate it.
procedure DeleteItem(anItemId: string);
Delete an item from the cache.
function GenerateUniqueCaption(const aBaseCaption: string; const aFilteredItems: array of
string): string;
Generates a unique caption amongst all cached items.
function GetItemFromCache(anItemId: string): THndLibraryItemsCacheInfo;
Get item cache info.
procedure Invalidate;
Invalidate all the items from the cache.
procedure InvalidateVariables;
Invalidate the variable values based on user changes.
procedure SetProjectName(const aProjectName: string);
Defines the project name.
procedure CloseProject;
Closes the currently openned project.
function CopyProject(const aNewProjectName: string; const OpenNewOne: Boolean): Boolean;
Copy the project to a new location and open the new one if needed.
function DeleteProject: Boolean;
Physically delete the currently openned project.
function GetProjectAuthor: string;
Returns the author of the project.
function GetProjectBusy: Boolean;
Project is currently busy: creating, loading or closing.
function GetProjectCharset: Integer;
Returns the project current charset.
function GetProjectCharsetAsHtml: string;
Returns the project current charset as HTML charset value.
function GetProjectClosing: Boolean;
Project is currently closing.
function GetProjectComment: string;
Return the current project's comment.
function GetProjectCopyright: string;
Returns the project copyright.
SDK application API:C# PDF Convert to Jpeg SDK: Convert PDF to JPEG images in
NET library to batch convert PDF files to jpg image files. Turn multiple pages PDF into single jpg files respectively online.
SDK application API:VB.NET PDF Convert to Jpeg SDK: Convert PDF to JPEG images in vb.
RasterEdge. PRODUCTS: ONLINE DEMOS: Online HTML5 Document Viewer; Online XDoc.PDF Word to PDF; Convert Excel to PDF; Convert PowerPoint to PDF; Convert Image
HelpNDoc User Manual
75 / 87
function GetProjectCreating: Boolean;
Project is currently being created.
function GetProjectCssContent: string;
Returns the CSS content of the current project. Can only be returned when generating an HTML
related format.
function GetProjectId: string;
Returns the currently open project id.
function GetProjectLanguage: Integer;
Returns the project current language.
function GetProjectLanguageCode: string;
Returns the project language code (eg: en-us)
function GetProjectModified: Boolean;
Indicates whether or no the current project has been modified since last save.
function GetProjectName: string;
Returns the current project name (or file name).
function GetProjectNeverSaved: Boolean;
Indicates whether the project as already been saved or not.
function GetProjectOpenning: Boolean;
Returns True if the project is currently openning.
function GetProjectSummary: string;
Returns the project summary.
function GetProjectTitle: string;
Gets the title of the specified project.
function GetProjectVersion: string;
Return the current project's version number.
function MoveProject(const aNewProjectName: string): Boolean;
Move the project to a new location.
function NewProject(const aProjectName: string = ''): string;
Creates a new project and returns its unique id.
function OpenProject(const aProjectName: string): string;
Open an existing project and returns its unique id.
procedure SaveProject;
Saves the project to a file.
procedure SetProjectAuthor(const anAuthor: string);
Defines the project author.
procedure SetProjectCharset(const aCharSet: Integer);
Defines the project charset.
procedure SetProjectComment(const aComment: string);
Set the current project comment.
procedure SetProjectCopyright(const aCopyrightValue: string);
Defines the project copyright.
SDK application API:C# HTML5 PDF Viewer SDK to view PDF document online in C#.NET
RasterEdge. PRODUCTS: ONLINE DEMOS: Online HTML5 Document Viewer; Online XDoc.PDF Word to PDF; Convert Excel to PDF; Convert PowerPoint to PDF; Convert Image
SDK application API:VB.NET PDF Convert to HTML SDK: Convert PDF to html files in vb.
Convert PDF to HTML. |. Home ›› XDoc.PDF ›› VB.NET PDF: PDF to HTML. Convert PDF to HTML in VB.NET Demo Code. Add necessary references:
HelpNDoc User Manual
76 / 87
procedure SetProjectLanguage(const aLanguage: Integer);
Defines the project language.
procedure SetProjectModified(const IsModified: Boolean = True);
Mark the current project as being modified since last save.
procedure SetProjectNeverSaved(const IsProjectNeverSaved: Boolean = True);
Mark the project as being never saved.
procedure SetProjectSummary(const aSummary: string);
Set the project summary.
procedure SetProjectTitle(const aProjectTitle: string);
Sets the title of the specified project.
procedure SetProjectVersion(const aProjectVersion: string);
Sets the version of the current project.
function VacuumProject: Boolean;
Clean the project and lower its file size by removing unneeded information.
function GetItemMetaRawValue(const aKey: string): WideString; override;
Returns the raw IROStrings value for the property of the specified item.
procedure SetItemMetaRawValue(const aKey: string; const aRawValue: WideString); override;
Assign a raw value to a specific key.
procedure LoadFromProject(aRVStyle: TRVStyle);
Load the style templates from the project.
procedure NotifyStyleTemplatesChange(Sender: TObject);
Notify sbuscribers that the style list has changed.
procedure ResetStyleTemplates(aRVStyle: TRVStyle; doNotify: Boolean = True);
Reset the style templates by loading the default.hns styles file.
procedure SaveToProject(aRVStyle: TRVStyle);
Save the content of the style template to the project.
function GetTemplateKindList: TStringDynArray;
Returns a list of template kinds available on the system: 'html', 'chm'...
function GetDefaultTemplateFor(const aTemplateKind: string): THndTemplateInfo;
Get the default template info for the specified kind.
function GetTemplateCategoryHierarchy: THndTemplateHierarchyArray;
Returns the full category hierarchy of available templates.
function GetTemplateFromName(const aTemplateName, aTemplateKind: string):
Returns a specific template based on its name and kind.
function GetTemplateList: THndTemplateInfoArray;
Returns a list of available templates on specified kind, or all kinds if none specified.
HelpNDoc User Manual
77 / 87
procedure UpdateTemplateList;
Retrieves the templates from the hard drive.
function CopyAndMergeTemplateToFolder(const aTemplateInfo: THndTemplateInfo; const
aFolder: string): Boolean;
Copy the template to the specific folder, merging its info file with existing template in that folder.
function GetTemplateInfoFromPath(const aTemplatePath: string): THndTemplateInfo;
Get template info from its path.
function GetTemplateKindFromPath(const aTemplatePath: string): string;
Returns the kind of template available at the speicified path.
function GetTemplateRawNameFromPath(aTemplatePath: string): string;
Returns the template directory name from path.
Create, edit and manage topics within the current project.
procedure CopyTopicToClipboard(const aTopicId: string; const isCut: Boolean);
Copy the specified topic to clipboard.
procedure CreateMultipleTopics(const aTopicList: TStrings; const aParentTopic: string =
Creates multiple child topics of the specified parent based on a tabular lists.
function CreateTopic: string;
Create a new topic. The topic will be placed at the bottom of the topic list.
procedure DeleteAllTopics;
Delete all the topics in the project, except the parent topic.
function DeleteTopic(const aTopicId: string): Boolean;
Delete a specific topic and its children. Project topic can't be deleted.
function GenerateUniqueHelpContext(const aBaseHelpContext: Integer; const
aFilteredTopics: array of string): Integer;
Generates a unique help context among all the topics except the filtered ones.
function GenerateUniqueHelpId(const aBaseHelpId: string; const aFilteredTopics: array of
string): string;
Generates a unique help id among all the topics except the filtered ones.
function GetCurrentTopic: string;
Returns the ID of the currently edited topic.
function GetProjectTopic: string;
Returns the root project topic.
function GetTopicCaption(const aTopicId: string): string;
Get the caption of a specific topic.
function GetTopicContent(const aTopicId: string): TMemoryStream;
Returns the content of the specified topic.
function GetTopicContentAsHtml(const aTopicId: string): string;
Get the topic's content as HTML. Only available when generating an HTML related
HelpNDoc User Manual
78 / 87
function GetTopicCount: Integer;
Returns the number of topics available in the current project.
function GetTopicCreationDateTime(const aTopicId: string): TDateTime;
Returns the date and time when the topics was created.
function GetTopicDirectChildrenCount(const aParentId: string): Integer;
Returns the number of direct children a topic has.
function GetTopicDirectChildrenCountVisible(const aParentId: string): Integer;
Returns the number of direct visible children a topic has.
function GetTopicDirectChildrenList(const aParentId: string): THndTopicsInfoArray;
Returns a list of direct children of the specified topic.
function GetTopicDirectChildrenListVisible(const aParentId: string): THndTopicsInfoArray;
Returns a list of direct visible children of the specified topic.
function GetTopicFirst: string;
Returns the first topic in the project.
function GetTopicFooterKind(const aTopicId: string): Integer;
Returns the topic's kind of footer text: normal, custom, hidden.
function GetTopicFooterText(const aTopicId: string): string;
Returns the custom topic footer text.
function GetTopicFooterTextCalculated(const aTopicId: string): string;
Returns the footer text based on the header kind: project caption, custom text or empty text for
hidden footer.
function GetTopicHeaderKind(const aTopicId: string): Integer;
Returns the topic's kind of header text: normal, custom, hidden.
function GetTopicHeaderText(const aTopicId: string): string;
Returns the custom topic header text.
function GetTopicHeaderTextCalculated(const aTopicId: string): string;
Returns the header text based on the header kind: topic title, custom text or empty text for hidden
function GetTopicHelpContext(const aTopicId: string): Integer;
Get a specific topic's help context.
function GetTopicHelpId(const aTopicId: string): string;
Get a specific topic's help id.
function GetTopicIconIndex(const aTopicId: string): Integer;
Get the icon index for a specific topic.
function GetTopicIndex(const aTopicId: string; const isZeroBased: Boolean = True):
Returns the index of the topic from its parent.
function GetTopicIndexHierarchy(const aTopicId: string; const isZeroBased: Boolean =
True): THndIntegerArray;
Returns an array representing the topic's index hierarchy. Ex: [1,0,3,4] for
function GetTopicIsVisible(const aTopicId: string; const isIncludingParents: Boolean =
True): Boolean;
Returns True if a topic is visible False otherwise.
HelpNDoc User Manual
79 / 87
function GetTopicKind(const aTopicId: string): Integer;
Returns the kind of the specific topic.
function GetTopicLast: string;
Returns the last topic in the project.
function GetTopicLevel(const aTopicId: string): Integer;
Returns the level of the specified topic.
function GetTopicList(const aIncludingProjectTopic: Boolean = False):
Returns a list of topics and their associated ID as object.
function GetTopicListVisible(const aIncludingProjectTopic: Boolean = False):
Returns a list of visible topics and their associated ID as object.
function GetTopicModificationDateTime(const aTopicId: string): TDateTime;
Returns the date and time when the topic was last modified.
function GetTopicNext(const aTopicId: string): string;
Get the next topic in line. Could be a child or a sibling topic.
function GetTopicNextSibbling(const aTopicId: string): string;
Get the next sibling topic.
function GetTopicNextSibblingVisible(const aTopicId: string): string;
Returns the next visible sibling topic.
function GetTopicNextVisible(const aTopicId: string): string;
Returns the next visible topic.
function GetTopicOrder(const aTopicId: string): Integer;
Returns the order of the topic based on sibling topics.
function GetTopicParent(const aTopicId: string): string;
Returns the parent topic of a topic.
function GetTopicPrevious(const aTopicId: string): string;
Returns a list of topics and their associated ID as object.
function GetTopicPreviousSibbling(const aTopicId: string): string;
Get the previous sibling topic.
function GetTopicPreviousSibblingVisible(const aTopicId: string): string;
Returns the previous visible sibling topic.
function GetTopicPreviousVisible(const aTopicId: string): string;
Returns the previous visible topic.
function GetTopicUrlFile(const aTopicId: string): string;
Returns the topic's URL file property.
function GetTopicUrlLink(const aTopicId: string): string;
Returns the topic's URL link property.
function MoveTopic(const aTopicId, aReferencedTopicId: string; const oAttachMode:
THndTopicsAttachMode): Boolean;
Move the topic to a new position in reference to nReferencedTopicsId.
function MoveTopicDown(const aTopicId: string): Boolean;
HelpNDoc User Manual
80 / 87
Move the specific topic bellow the next sibling.
function MoveTopicLeft(const aTopicId: string): Boolean;
Move the specific topic left in the hierarchy.
function MoveTopicRight(const aTopicId: string): Boolean;
Move the specific topic right in the hierarchy.
function MoveTopicUp(const aTopicId: string): Boolean;
Move the specific topic above the previous sibling.
procedure PasteTopicFromClipboard(aParentId: string);
Paste the topic from clipboard as a child of the parent specified or as a child of the project topic.
function SetCurrentTopic(const aTopicId: string): Boolean;
Defines the currently selected topic.
procedure SetTopicCaption(const aTopicId, sNewCaption: string);
Defines the specific topic's caption.
procedure SetTopicContent(const aTopicId: string; const aContentStream: TStream);
Set the topic's content.
procedure SetTopicFooterKind(const aTopicId: string; const aFooterKind: Integer);
Sets the topic footer kind.
function SetTopicFooterText(const aTopicId, aFooterText: string): string;
Sets the custom text for the topic footer.
procedure SetTopicHeaderKind(const aTopicId: string; const anHeaderKind: Integer);
Sets the topic header kind.
function SetTopicHeaderText(const aTopicId, anHeaderText: string): string;
Sets the custom text for the topic header.
function SetTopicHelpContext(const aTopicId: string; const aHelpContext: Integer):
Set a specific topic's help context. Returns the corrected context.
function SetTopicHelpId(const aTopicId, aHelpId: string): string;
Set a specific topic's help id. Returns the corrected string.
procedure SetTopicIconIndex(const aTopicId: string; const nIconIndex: Integer);
Set the icon index of a specific topic.
procedure SetTopicIsVisible(const aTopicId: string; const isVisible: Boolean);
Set the visibility for the topic
function SetTopicKind(const aTopicId: string; const aNewKind: Integer): Integer;
Set the topic kind (1: normal; 2: empty; 3: Link to URL; 4: Link to file)
procedure SetTopicUrlFile(const aTopicId, anUrlFile: string);
Set the topic's URL file.
procedure SetTopicUrlLink(const aTopicId, anUrlLink: string);
Set the topic's URL link.
procedure SynchronizeAllHelpIds;
Overwrite all topic's help Ids based on caption.
Documents you may be interested
Documents you may be interested