HelpMacroId Property - Cloud - Author-it

Development Documentation

Welcome to Author-it Development Documentation
How to Use the Author-it Development Documentation Site
Filter by API Version
Search the Development Documentation Content
Getting Help
Developer's Hub Forum FAQs
Do I have to be registered to use the Developer's Hub forum?
How can I be notified of a reply to a thread I am interested in?
How do I create a thread or post a reply?
How do I login?
How do I manage my settings for the forum?
How do I search the forum?
How do I see the threads or posts I have created?
What do I do if I forgot my password?
What do I do if I have further questions about the forum?
Author-it SDK Overview
SDK Contents
Get Started With the Author-it SDK
Supported Libraries Versions
Choose the Author-it Development Technology You Will Use
Add Functionality to Author
Automate Library Tasks
Automate the Author User Interface
Hide or Disable Features in Author
Make Changes in a Library From Another System
Install the Author-it SDK Components
Author-it API for the .NET Framework
Install the Author-it API for the .NET Framework
API Server Internet Information Services
Installing the Author-it API Server for IIS
Configure Authentication for API Server Internet Information Services
Configure Authentication for API Server Internet Information Services with IIS Manager 6
Configure Authentication for API Server Internet Information Services with IIS Manager 7
Configure the API Server Internet Information Services to Support Author-it Cloud Authentication
Configure the Apache Server Application Programming Interface to Require an API Token
Configure an API Token for a Server Application Programming Server Library
Configure a Library Alias URL for a Server Application Programming Server Library
Test the Server Application Programming Server Installation
Post Installation Test 1
Post Installation Test 2
Author-it API Server Service
Install and Configure the Author-it API Server Service
Test the Server Application Programming Server Installation
Post Installation Test 1
Post Installation Test 2
API Server Configuration Tool
Install the API Server Configuration Tool
Configure the Apache Server Application Programming Interface
Configure the Apache Server Application Programming Interface for a Library
Author-it API Concepts
Data Transfer Objects (DTOs)
Services
Methods
Samples
General Concepts (ExtJS)
General Concepts (JQuery)
General Concepts (ASP.NET Ajax)
General Concepts (Winforms, Direct Reference)
General Concepts (Winforms, SOAP)
General Concepts (Winforms, TCP)
Develop Author Plug-ins
Overview
Types of Author Plug-ins
Button Plug-ins
Add a Button to the Book Editor
Add a Button to the Main Form
Context Menu Item Plug-ins
Add a Context Menu Item to the Book Tree Context Menu
Add a Context Menu Item to the Object List Context Menu
Add a Context Menu Item to the Text Editor Context Menu
Control Deactivation Plug-ins
Controls That You Can Deactivate
Types Of Deactivation
Plug-in Communication for Deactivating Controls
Event-Triggered Plug-ins
Add a Plug-in to an Event in Author
Update the Author User Interface
Building a Plug-in
Requirements
Create a New Project
Create a PluginManager Class
Implement the IPlugin Interface
Reference the AitApplicationProxy
Set Launch Point Properties
Define the OnClick Handler
Deploying the Plug-in
Develop Apache Server Application Programming Interface Applications
Manage State in the Apache Server Application Programming Interface
WCF Cookie Manager
Set Server Application Programming Server Endpoints at Runtime
Author-it Developer Reference
Author-it API Class Library Reference
Authorit.API Namespace
ApplicationContext Class
ApplicationContext() Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList) Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList, Authorit.API.ApplicationType) Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList, Authorit.API.ApplicationType, bool) Constructor
ApplicationContext.GetServiceInstance<TService>() Method
ApplicationContext.LibrariesConfiguration Property
ApplicationContext.LibraryUtility Property
ApplicationType Enumeration
ApplicationType.AspNet Value
ApplicationType.SingleUser Value
ApplicationType.UserPerThread Value
ApplicationType.Wcf Value
LibraryUtility Class
LibraryUtility.GetTargetLibraryConfiguration(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.GetVersion(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.TestConnection(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.Upgrade(Authorit.API.Configuration.LibraryConfigurationBase, Authorit.API.Security.UserCredentials) Method
PropertyChangingEventArgs Class
PropertyChangingEventArgs(string, object, object) Constructor
PropertyChangingEventArgs.NewValue Property
PropertyChangingEventArgs.OldValue Property
Authorit.API.Configuration Namespace
JetLibraryConfiguration Class
JetLibraryConfiguration.Description Property
JetLibraryConfiguration.GetSchema() Method
JetLibraryConfiguration() Constructor
JetLibraryConfiguration.JetLibraryConfiguration(string, string) Constructor
JetLibraryConfiguration.LibraryType Property
JetLibraryConfiguration.Path Property
JetLibraryConfiguration.ReadXml(System.Xml.XmlReader) Method
JetLibraryConfiguration.ToString() Method
JetLibraryConfiguration.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationBase Class
LibraryConfigurationBase.Alias Property
LibraryConfigurationBase.AliasChanging Event
LibraryConfigurationBase.Description Property
LibraryConfigurationBase.GetSchema() Method
LibraryConfigurationBase.LibraryType Property
LibraryConfigurationBase.ReadXml(System.Xml.XmlReader) Method
LibraryConfigurationBase.Validate() Method
LibraryConfigurationBase.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationList Class
LibraryConfigurationList() Constructor
LibraryConfigurationList(Authorit.API.Configuration.LibraryConfigurationBase) Constructor
LibraryConfigurationList.Add(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryConfigurationList.Aliases Property
LibraryConfigurationList.Clear() Method
LibraryConfigurationList.Contains(string) Method
LibraryConfigurationList.Count Property
LibraryConfigurationList.GetEnumerator() Method
LibraryConfigurationList.GetSchema() Method
LibraryConfigurationList.ReadXml(System.Xml.XmlReader) Method
LibraryConfigurationList.Remove(string) Method
LibraryConfigurationList.ToString() Method
LibraryConfigurationList.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationList[int] Property
LibraryConfigurationList[string] Property
LoggingConfiguration Class
LoggingConfiguration() Constructor
LoggingConfiguration(Authorit.API.Configuration.LogLevel, Authorit.API.Configuration.LogLevel) Constructor
LoggingConfiguration.FileLogLevel Property
LoggingConfiguration.GetSchema() Method
LoggingConfiguration.ReadXml(System.Xml.XmlReader) Method
LoggingConfiguration.TraceLogLevel Property
LoggingConfiguration.WriteXml(System.Xml.XmlWriter) Method
LogLevel Enumeration
LogLevel.All Value
LogLevel.Debug Value
LogLevel.Error Value
LogLevel.Fatal Value
LogLevel.Info Value
LogLevel.None Value
LogLevel.Warn Value
SqlServerLibraryConfiguration Class
SqlServerLibraryConfiguration() Constructor
SqlServerLibraryConfiguration(string, string, string) Constructor
SqlServerLibraryConfiguration(string, string, string, string, string) Constructor
SqlServerLibraryConfiguration.ConnectionPoolingEnabled Property
SqlServerLibraryConfiguration.Database Property
SqlServerLibraryConfiguration.Description Property
SqlServerLibraryConfiguration.GetSchema() Method
SqlServerLibraryConfiguration.LibraryType Property
SqlServerLibraryConfiguration.LoginID Property
SqlServerLibraryConfiguration.Password Property
SqlServerLibraryConfiguration.ReadXml(System.Xml.XmlReader) Method
SqlServerLibraryConfiguration.Server Property
SqlServerLibraryConfiguration.ToString() Method
SqlServerLibraryConfiguration.TrustedConnection Property
SqlServerLibraryConfiguration.WriteXml(System.Xml.XmlWriter) Method
Authorit.API.Dto Namespace
AuthorITModule Enumeration
AuthorITModule.Administrator Value
AuthorITModule.Editor Value
AuthorITModule.LocalizationManager Value
AuthorITModule.Reviewer Value
BaseObject Class
BaseObject.BasedOnDescription Property
BaseObject.BasedOnId Property
BaseObject() Constructor
BaseObject.Description Property
BaseObject.FolderId Property
BaseObject.Guid Property
BaseObject.IsStructureTemplate Property
BaseObject.IsTemplate Property
BaseObject.ModifiedBy Property
BaseObject.ModifiedDate Property
BaseObject.ObjectCode Property
BaseObject.ObjectId Property
BaseObject.ObjectType Property
BaseObject.ReleaseStateId Property
BaseObject.VariantParentId Property
BaseObject.Version Property
Book Class
Book() Constructor
Book.HelpCitation Property
Book.HelpCompression Property
Book.HelpCopyright Property
Book.HelpFileName Property
Book.HelpLinkIncludeFile Property
Book.HelpLinkPrefix Property
Book.HelpLinkTopicOffset Property
Book.HelpMacro Property
Book.HelpTitle Property
Book.IncludeInHelp Property
Book.IncludeInPrint Property
Book.IncludeInWeb Property
Book.ObjectType Property
Book.PrintByLine Property
Book.PrintSubTitle Property
Book.PrintSuperTitle Property
Book.PrintTitle Property
Book.PrintVersion Property
Book.PrintWordTemplate Property
Book.TableOfContents Property
Book.WebAdditionalFiles Property
Book.WebBaseFontSize Property
Book.WebBaseUrl Property
Book.WebByLine Property
Book.WebFramesetTemplate Property
Book.WebSuperTitle Property
Book.WebTitle Property
Book.WebVersion Property
BookTocEntry Class
BookTocEntry() Constructor
BookTocEntry.Children Property
BookTocEntry.ObjectId Property
Constants Class
Constants.NoReleaseStateId Property
Constants.RootFolderId Property
File Class
File() Constructor
File.HelpBitmapAlignment Property
File.HelpBitmapTransparent Property
File.HelpDirectory Property
File.HelpFileName Property
File.HelpOutputFormat Property
File.HelpParagraphStyleId Property
File.HelpScaleHeight Property
File.HelpScaleWidth Property
File.HelpSizeHeight Property
File.HelpSizeWidth Property
File.HelpSizingMethod Property
File.HelpSourceType Property
File.HelpVideoAutoPlay Property
File.HelpVideoAutoRepeat Property
File.HelpVideoShowMenuButton Property
File.HelpVideoShowPlayBar Property
File.HyperlinkId Property
File.IncludeInHelp Property
File.IncludeInPrint Property
File.IncludeInWeb Property
File.ObjectType Property
File.PrintBorderBottom Property
File.PrintBorderLeft Property
File.PrintBorderRight Property
File.PrintBorderTop Property
File.PrintCaption Property
File.PrintCaptionPosition Property
File.PrintDirectory Property
File.PrintFileName Property
File.PrintLabelType Property
File.PrintOutputFormat Property
File.PrintParagraphStyleId Property
File.PrintScaleHeight Property
File.PrintScaleWidth Property
File.PrintSizeHeight Property
File.PrintSizeWidth Property
File.PrintSizingMethod Property
File.PrintSourceType Property
File.WebAdditionalFiles Property
File.WebAlignment Property
File.WebAlternateText Property
File.WebBorder Property
File.WebDirectory Property
File.WebFileName Property
File.WebImageMap Property
File.WebOutputFormat Property
File.WebSizeHeight Property
File.WebSizeWidth Property
File.WebSourceType Property
File.WebSpacingHorizontal Property
File.WebSpacingVertical Property
File.WebStartVideo Property
File.WebVideoControls Property
File.WebVideoReplay Property
File.WebVideoReplayAmount Property
FileBorderStyle Enumeration
FileBorderStyle.Dashed0_75pt Value
FileBorderStyle.Dotted0_75pt Value
FileBorderStyle.Double0_75pt Value
FileBorderStyle.Double1_5 Value
FileBorderStyle.Double2_25pt Value
FileBorderStyle.None Value
FileBorderStyle.Solid0_75pt Value
FileBorderStyle.Solid1_5pt Value
FileBorderStyle.Solid2_25pt Value
FileBorderStyle.Solid3pt Value
FileBorderStyle.Solid4_5pt Value
FileBorderStyle.Solid6pt Value
FileCaptionPosition Enumeration
FileCaptionPosition.Above Value
FileCaptionPosition.Below Value
FileHelpBitmapAlignment Enumeration
FileHelpBitmapAlignment.LeftMargin Value
FileHelpBitmapAlignment.RightMargin Value
FileHelpBitmapAlignment.TextCharacter Value
FileHelpSourceType Enumeration
FileHelpSourceType.Embedded Value
FileHelpSourceType.LinkedOle Value
FileHelpSourceType.LinkedPicture Value
FileHelpSourceType.LinkedRtf Value
FileHelpSourceType.LinkedUrl Value
FileHelpSourceType.LinkedVideo Value
FileLabelType Enumeration
FileLabelType.Equation Value
FileLabelType.Figure Value
FileLabelType.Table Value
FileOutputFormat Enumeration
FileOutputFormat.Bmp Value
FileOutputFormat.Eps Value
FileOutputFormat.Gif Value
FileOutputFormat.Jpeg Value
FileOutputFormat.Png Value
FileOutputFormat.Source Value
FileOutputFormat.Tiff Value
FileOutputFormat.Wmf Value
FilePrintSourceType Enumeration
FilePrintSourceType.Embedded Value
FilePrintSourceType.LinkedDocument Value
FilePrintSourceType.LinkedOle Value
FilePrintSourceType.LinkedPicture Value
FilePrintSourceType.LinkedUrl Value
FileSizingMethod Enumeration
FileSizingMethod.Scale Value
FileSizingMethod.Size Value
FileWebAlignment Enumeration
FileWebAlignment.Bottom Value
FileWebAlignment.Left Value
FileWebAlignment.Middle Value
FileWebAlignment.Right Value
FileWebAlignment.Top Value
FileWebSourceType Enumeration
FileWebSourceType.Embedded Value
FileWebSourceType.LinkedHtml Value
FileWebSourceType.LinkedPicture Value
FileWebSourceType.LinkedUrl Value
FileWebSourceType.LinkedVideo Value
FileWebStartVideo Enumeration
FileWebStartVideo.Both Value
FileWebStartVideo.Manual Value
FileWebStartVideo.MouseOver Value
FileWebStartVideo.Open Value
FileWebVideoReplay Enumeration
FileWebVideoReplay.Continuous Value
FileWebVideoReplay.Specific Value
Folder Class
Folder() Constructor
Folder.FolderId Property
Folder.Guid Property
Folder.HasChildren Property
Folder.Name Property
Folder.ParentFolderId Property
Group Class
Group() Constructor
Group.ActiveDirectoryGroup Property
Group.GroupId Property
Group.Name Property
HeadingAutoNumberStyle Enumeration
HeadingAutoNumberStyle.AlphabeticalLowerCase Value
HeadingAutoNumberStyle.AlphabeticalUpperCase Value
HeadingAutoNumberStyle.Digits Value
HeadingAutoNumberStyle.DigitsText Value
HeadingAutoNumberStyle.None Value
HeadingAutoNumberStyle.Ordinals Value
HeadingAutoNumberStyle.OrdinalsAbbreviated Value
HeadingAutoNumberStyle.RomanLowerCase Value
HeadingAutoNumberStyle.RomanUpperCase Value
HelpCompression Enumeration
HelpCompression.HallOnText Value
HelpCompression.Maximum Value
HelpCompression.None Value
HelpCompression.PhraseOnText Value
HelpCompression.RLEOnBitmaps Value
HelpCompression.ZeckOnBitmaps Value
HelpCompression.ZeckOnText Value
HelpLinkType Enumeration
HelpLinkType.Default Value
HelpLinkType.Popup Value
HelpLinkType.Window Value
HelpTocDisplayType Enumeration
HelpTocDisplayType.DefaultWindow Value
HelpTocDisplayType.ExecuteMacro Value
HelpTocDisplayType.HeadingOnly Value
HelpTocDisplayType.Hide Value
HelpTocDisplayType.Popup Value
Hyperlink Class
Hyperlink() Constructor
Hyperlink.HelpLinkIncludeButton Property
Hyperlink.HelpLinkRemoveUnderline Property
Hyperlink.HelpLinkType Property
Hyperlink.HelpLinkWindow Property
Hyperlink.IncludeInHelp Property
Hyperlink.IncludeInPrint Property
Hyperlink.IncludeInWeb Property
Hyperlink.ObjectType Property
Hyperlink.PrintCrossReferenceBrackets Property
Hyperlink.PrintCrossReferenceIncludeHeading Property
Hyperlink.PrintCrossReferenceIncludePageNumber Property
Hyperlink.PrintCrossReferenceIncludePageNumberText Property
Hyperlink.PrintCrossReferenceText Property
Hyperlink.PrintFootnoteCustom Property
Hyperlink.PrintFootnoteNumberFormat Property
Hyperlink.PrintFootnoteNumberType Property
Hyperlink.PrintLinkType Property
Hyperlink.TopicTargets Property
Hyperlink.WebHelpPopupFontName Property
Hyperlink.WebHelpPopupFontSize Property
Hyperlink.WebHelpPopupMarginsHorizontal Property
Hyperlink.WebHelpPopupMarginsVertical Property
Hyperlink.WebLinkType Property
Hyperlink.WebPopupDHTMLStyleId Property
Hyperlink.WebPopupHeight Property
Hyperlink.WebPopupPositionLeft Property
Hyperlink.WebPopupPositionTop Property
Hyperlink.WebPopupWidth Property
Hyperlink.WebTargets Property
Hyperlink.WebWindowName Property
Hyperlink.WebWindowResizable Property
Hyperlink.WebWindowShowToolbar Property
Hyperlink.WebWindowStatusVisible Property
Hyperlink.WebWindowUseJavaScript Property
HyperlinkWebTarget Class
HyperlinkWebTarget() Constructor
HyperlinkWebTarget.Description Property
HyperlinkWebTarget.Url Property
LibraryInformation Class
LibraryInformation() Constructor
LibraryInformation.Comments Property
LibraryInformation.Company Property
LibraryInformation.Language Property
LibraryInformation.Name Property
LibraryInformation.Owner Property
LibraryInformation.Path Property
LibraryInformation.Subject Property
LibraryInformation.Title Property
LibraryOptions Class
LibraryOptions() Constructor
LibraryOptions.FileObjectThumbnailFolderIds Property
ListType Enumeration
ListType.Bulleted Value
ListType.ListContinue Value
ListType.NotList Value
ListType.Numbered Value
Localization Class
Localization() Constructor
Localization.Abbreviation Property
Localization.Description Property
Localization.Guid Property
Localization.LocalizationId Property
Localization.TargetLibraryId Property
Localization.TargetLibraryName Property
LoginResponse Class
LoginResponse() Constructor
LoginResponse.Result Property
LoginResponse.Token Property
LoginResult Enumeration
LoginResult.FailureDatabaseNotFound Value
LoginResult.FailureError Value
LoginResult.FailureIncorrectUsernameOrPassword Value
LoginResult.FailureLibraryFutureVersion Value
LoginResult.FailureLibraryOpen Value
LoginResult.FailureLibraryUpgradeNeeded Value
LoginResult.FailureLicensing Value
LoginResult.Success Value
ObjectBrief Class
ObjectBrief() Constructor
ObjectBrief.BasedOnDescription Property
ObjectBrief.BasedOnId Property
ObjectBrief.Description Property
ObjectBrief.FolderId Property
ObjectBrief.Guid Property
ObjectBrief.IsTemplate Property
ObjectBrief.ModifiedBy Property
ObjectBrief.ModifiedDate Property
ObjectBrief.ObjectCode Property
ObjectBrief.ObjectId Property
ObjectBrief.ObjectType Property
ObjectBrief.ReleaseStateId Property
ObjectBrief.VariantParentId Property
ObjectBrief.Version Property
ObjectCreatePermission Enumeration
ObjectCreatePermission.All Value
ObjectCreatePermission.BookCreate Value
ObjectCreatePermission.BookCreateTemplate Value
ObjectCreatePermission.FileCreate Value
ObjectCreatePermission.FileCreateTemplate Value
ObjectCreatePermission.GlossaryCreate Value
ObjectCreatePermission.GlossaryCreateTemplate Value
ObjectCreatePermission.HyperlinkCreate Value
ObjectCreatePermission.HyperlinkCreateTemplate Value
ObjectCreatePermission.IndexCreate Value
ObjectCreatePermission.IndexCreateTemplate Value
ObjectCreatePermission.IndexEntryCreate Value
ObjectCreatePermission.IndexEntryCreateTemplate Value
ObjectCreatePermission.MacroCreate Value
ObjectCreatePermission.MacroCreateTemplate Value
ObjectCreatePermission.MediaCreate Value
ObjectCreatePermission.MediaCreateTemplate Value
ObjectCreatePermission.None Value
ObjectCreatePermission.PublishProfileCreate Value
ObjectCreatePermission.PublishProfileCreateTemplate Value
ObjectCreatePermission.StyleCreate Value
ObjectCreatePermission.StyleCreateTemplate Value
ObjectCreatePermission.TOCCreate Value
ObjectCreatePermission.TOCCreateTemplate Value
ObjectCreatePermission.TOFCreate Value
ObjectCreatePermission.TOFCreateTemplate Value
ObjectCreatePermission.TopicCreate Value
ObjectCreatePermission.TopicCreateTemplate Value
ObjectCreatePermission.TPageCreate Value
ObjectCreatePermission.TPageCreateTemplate Value
ObjectHistoryItem Class
ObjectHistoryItem.ModifiedBy Property
ObjectHistoryItem.ModifiedDate Property
ObjectHistoryItem.ModifiedId Property
ObjectHistoryItem.ModifiedType Property
ObjectHistoryItem() Constructor
ObjectHistoryItem.ObjectId Property
ObjectHistoryItem.XmlStatus Property
ObjectHistoryModifiedType Enumeration
ObjectHistoryModifiedType.LibraryImport Value
ObjectHistoryModifiedType.LocalizationUpdate Value
ObjectHistoryModifiedType.Revert Value
ObjectHistoryModifiedType.TranslationJob Value
ObjectHistoryModifiedType.User Value
ObjectHistoryModifiedType.XMLImport Value
ObjectHistoryXmlStatus Enumeration
ObjectHistoryXmlStatus.Archived Value
ObjectHistoryXmlStatus.InDatabase Value
ObjectHistoryXmlStatus.None Value
ObjectListSort Enumeration
ObjectListSort.BasedOn Value
ObjectListSort.CreatedDate Value
ObjectListSort.Description Value
ObjectListSort.ModifiedByDate Value
ObjectListSort.ModifiedByUsername Value
ObjectListSort.ObjectCode Value
ObjectListSort.ObjectId Value
ObjectListSort.ObjectType Value
ObjectListSort.ReleaseState Value
ObjectListSort.StructureValidity Value
ObjectListSort.Version Value
ObjectLockInformation Class
ObjectLockInformation() Constructor
ObjectLockInformation.IsCurrentSession Property
ObjectLockInformation.ObjectId Property
ObjectLockInformation.UserName Property
ObjectRelationship Enumeration
ObjectRelationship.UsedBy Value
ObjectRelationship.Uses Value
ObjectSearchCriteria Class
ObjectSearchCriteria() Constructor
ObjectSearchCriteria.Field Property
ObjectSearchCriteria.Value Property
ObjectSearchField Enumeration
ObjectSearchField.BasedOnDescription Value
ObjectSearchField.BasedOnId Value
ObjectSearchField.ContainingText Value
ObjectSearchField.Description Value
ObjectSearchField.FolderId Value
ObjectSearchField.InBookId Value
ObjectSearchField.IsTemplate Value
ObjectSearchField.ModifiedFromDate Value
ObjectSearchField.ModifiedToDate Value
ObjectSearchField.ObjectCode Value
ObjectSearchField.ObjectType Value
ObjectSearchField.ReleaseStateId Value
ObjectSearchField.ResolveSubBooks Value
ObjectSearchField.VariableAssignment Value
ObjectStatus Enumeration
ObjectStatus.Active Value
ObjectStatus.Inactive Value
ObjectStatus.Redundant Value
ObjectType Enumeration
ObjectType.Book Value
ObjectType.File Value
ObjectType.Glossary Value
ObjectType.Hyperlink Value
ObjectType.Index Value
ObjectType.IndexEntry Value
ObjectType.Macro Value
ObjectType.Media Value
ObjectType.PublishProfile Value
ObjectType.Style Value
ObjectType.TableOfContents Value
ObjectType.TableOfFigures Value
ObjectType.TitlePage Value
ObjectType.Topic Value
OutputType Enumeration
OutputType.Help Value
OutputType.Print Value
OutputType.Web Value
Permission Enumeration
Permission.All
Permission.ChangePermission
Permission.ChangeReleaseState
Permission.ChangeVersion
Permission.Delete
Permission.List
Permission.ModifyFolders
Permission.None
Permission.Publish
Permission.Read
Permission.Write
PrintBreakType Enumeration
PrintBreakType.Column Value
PrintBreakType.None Value
PrintBreakType.Page Value
PrintBreakType.Section Value
PrintCrossReferenceIncludeHeading Enumeration
PrintCrossReferenceIncludeHeading.Always Value
PrintCrossReferenceIncludeHeading.Never Value
PrintCrossReferenceIncludeHeading.WhenDifferent Value
PrintFootnoteNumberFormat Enumeration
PrintFootnoteNumberFormat.AlphabeticalLowerCase Value
PrintFootnoteNumberFormat.AlphabeticalUpperCase Value
PrintFootnoteNumberFormat.Digits Value
PrintFootnoteNumberFormat.RomanLowerCase Value
PrintFootnoteNumberFormat.RomanUpperCase Value
PrintFootnoteNumberType Enumeration
PrintFootnoteNumberType.Automatic Value
PrintFootnoteNumberType.Custom Value
PrintLinkType Enumeration
PrintLinkType.CrossReference Value
PrintLinkType.EmbeddedBlock Value
PrintLinkType.EmbeddedInline Value
PrintLinkType.FootNote Value
PublishingJob Class
PublishingJob.BookDescription Property
PublishingJob.BookId Property
PublishingJob.ComputerName Property
PublishingJob.EndTime Property
PublishingJob.Format Property
PublishingJob.JobId Property
PublishingJob.Message Property
PublishingJob.Path Property
PublishingJob.Priority Property
PublishingJob.ProfileDescription Property
PublishingJob.ProfileId Property
PublishingJob() Constructor
PublishingJob.StartTime Property
PublishingJob.Status Property
PublishingJob.SubmittedTime Property
PublishingJob.Url Property
PublishingJob.UserId Property
PublishJobUserSearchOption Enumeration
PublishJobUserSearchOption.AllJobs
PublishJobUserSearchOption.MyJobs
PublishPriority Enumeration
PublishPriority.High
PublishPriority.Low
PublishPriority.Medium
PublishStatus Enumeration
PublishStatus.Cancelled Value
PublishStatus.Completed Value
PublishStatus.Pending Value
PublishStatus.Queued Value
PublishStatus.Started Value
PublishType Enumeration
PublishType.Aspect Value
PublishType.DITA Value
PublishType.HTML Value
PublishType.HTMLHelp Value
PublishType.JavaHelp Value
PublishType.OracleHelp Value
PublishType.PDF Value
PublishType.Website Value
PublishType.WinHelp Value
PublishType.Word Value
PublishType.XHTML Value
PublishType.XML Value
ReleaseState Class
ReleaseState.BackgroundColor Property
ReleaseState.ForegroundColor Property
ReleaseState.Guid Property
ReleaseState.Name Property
ReleaseState.ReleaseState Constructor
ReleaseState.ReleaseStateId Property
RoleProfile Class
RoleProfile.IsAuthor Property
RoleProfile.IsLocalizer Property
RoleProfile.IsReviewer Property
RoleProfile.IsSupervisor Property
SortDirection Enumeration
SortDirection.Ascending
SortDirection.Descending
Structure Class
Structure.Description Property
Structure.EnforcedReleaseStates Property
Structure.ExampleObjectId Property
Structure.Name Property
Structure.ObjectId Property
Structure.Rules Property
Structure.Structure Constructor
Structure.StructureId Property
StructureRule Class
StructureRule.AllowedIds Property
StructureRule.Children Property
StructureRule.Description Property
StructureRule.MaximumOccurrence Property
StructureRule.MinimumOccurrence Property
StructureRule.Name Property
StructureRule.ParentRuleId Property
StructureRule.RuleType Property
StructureRule.Sequence Property
StructureRule.StructureId Property
StructureRule.StructureRule Constructor
StructureRule.StructureRuleId Property
StructureRuleSequence Enumeration
StructureRuleSequence.Fixed
StructureRuleSequence.Flexible
StructureRuleType Enumeration
StructureRuleType.Book
StructureRuleType.CharacterStyle
StructureRuleType.EmbeddedTopic
StructureRuleType.File
StructureRuleType.Glossary
StructureRuleType.Group
StructureRuleType.Hyperlink
StructureRuleType.Index
StructureRuleType.Macro
StructureRuleType.ParagraphStyle
StructureRuleType.Table
StructureRuleType.TableCell
StructureRuleType.TableOfContents
StructureRuleType.TableOfFigures
StructureRuleType.TextRequired
StructureRuleType.TitlePage
StructureRuleType.Topic
StructureRuleType.Variable
StructureTableCellRule Class
StructureTableCellRule.MaximumRange Property
StructureTableCellRule.MinimumRange Property
StructureTableCellRule.StructureTableCellRule Constructor
StructureTableCellRule.TableRuleType Property
StructureTableCellRuleType Enumeration
StructureTableCellRuleType.AllColumns
StructureTableCellRuleType.AllRows
StructureTableCellRuleType.EvenColumns
StructureTableCellRuleType.EvenRows
StructureTableCellRuleType.FirstColumn
StructureTableCellRuleType.FirstRow
StructureTableCellRuleType.HeaderRow
StructureTableCellRuleType.LastColumn
StructureTableCellRuleType.LastRow
StructureTableCellRuleType.OddColumns
StructureTableCellRuleType.OddRows
StructureTableCellRuleType.RangeColumns
StructureTableCellRuleType.RangeRows
StructureValidity Enumeration
StructureValidity.Invalid
StructureValidity.NotApplicable
StructureValidity.NotValidated
StructureValidity.Valid
StyleType Enumeration
StyleType.Character
StyleType.Paragraph
Topic Class
Topic() Constructor
Topic.HelpHeading Property
Topic.HelpHeadingStyleId Property
Topic.HelpIncludeInBrowseSequence Property
Topic.HelpMacroId Property
Topic.HelpNonScrolling Property
Topic.HelpStartNewBrowseSequence Property
Topic.HelpTocDisplay Property
Topic.HelpTocMacroId Property
Topic.HelpWindowId Property
Topic.IncludeInHelp Property
Topic.IncludeInPrint Property
Topic.IncludeInWeb Property
Topic.ObjectType Property
Topic.PrintBreak Property
Topic.PrintHeading Property
Topic.PrintHeadingAutoNumberStyle Property
Topic.PrintHeadingStyleId Property
Topic.PrintMediaId Property
Topic.PrintSuperHeading Property
Topic.WebFilename Property
Topic.WebHeading Property
Topic.WebMediaId Property
Topic.WebStartNewPage Property
Topic.WebTitle Property
TranslationJob Class
TranslationJob.Description Property
TranslationJob.GroupId Property
TranslationJob.Guid Property
TranslationJob.JobReference Property
TranslationJob.LocalizatonId Property
TranslationJob.SourceLocalizationId Property
TranslationJob.Status Property
TranslationJob.TargetLocalizationId Property
TranslationJob.TranslationJob Constructor
TranslationJob.TranslationJobId Property
TranslationJobStatus Enumeration
TranslationJobStatus.ExportedForTranslation
TranslationJobStatus.ImportedFromTranslation
TranslationJobStatus.New
TranslationJobStatus.ReadyForImport
TranslationJobStatus.ReadyForTranslation
UserAccount Class
UserAccount() Constructor
UserAccount.ActiveDirectoryUser Property
UserAccount.Email Property
UserAccount.IsAuthorInherited Property
UserAccount.IsLocalizerInherited Property
UserAccount.IsReviewerInherited Property
UserAccount.IsSupervisorInherited Property
UserAccount.Name Property
UserAccount.UserId Property
Variable Class
Variable.Description Property
Variable.IsPublishPrompt Property
Variable.IsVariantCriteria Property
Variable.ListOfValues Property
Variable.ListOfValuesRelationships Property
Variable.Name Property
Variable.StyleId Property
Variable.Value Property
Variable.ValueObjectId Property
Variable.Variable Constructor
Variable.VariableId Property
Variable.VariableType Property
VariableAssignment Class
VariableAssignment.ObjectId Property
VariableAssignment.Value Property
VariableAssignment.ValueObjectId Property
VariableAssignment.VariableAssignment Constructor
VariableAssignment.VariableId Property
VariableType Enumeration
VariableType.FileObject Value
VariableType.ListOfValues Value
VariableType.System Value
VariableType.Text Value
WebLinkType Enumeration
WebLinkType.Default Value
WebLinkType.ExpandBlock Value
WebLinkType.ExpandInline Value
WebLinkType.NewWindow Value
WebLinkType.PopupClick Value
WebLinkType.PopupHover Value
WebLinkType.PopupNative Value
XtendSuggestedTopic Class
XtendSuggestedTopic.Description Property
XtendSuggestedTopic.Html Property
XtendSuggestedTopic.ID Property
XtendSuggestedTopic.XtendSuggestedTopic Constructor
XtendSuggestion Class
XtendSuggestion.FragmentId Property
XtendSuggestion.LocalizationIds Property
XtendSuggestion.PercentageMatch Property
XtendSuggestion.ReleaseStateIds Property
XtendSuggestion.ReuseCount Property
XtendSuggestion.Text Property
XtendSuggestion.UsedInTopicIds Property
XtendSuggestion.XtendSuggestion Constructor
Authorit.API.Exceptions Namespace
APIExceptionBase Class
AuthenticationException Class
AuthenticationException.AuthenticationException Constructor
AuthenticationException.FaultDetail Property
AuthenticationFaultDetail Class
AuthenticationFaultDetail.AuthenticationFaultDetail Constructor
ConfigurationException Class
ConfigurationException.ConfigurationException Constructor
ConfigurationException.ConfigurationException Constructor (string)
IdentifierException Class
IdentifierException.FaultDetail Property
IdentifierException.Identifier Property
IdentifierException.IdentifierException Constructor (object)
IdentifierException.Message Property
IdentifierFaultDetail Class
IdentifierFaultDetail.Identifier Property
IdentifierFaultDetail.IdentifierFaultDetail Constructor
IdentifierFaultDetail.IdentifierFaultDetail Constructor (object)
LicenseRoleMismatchDetail Class
LicenseRoleMismatchDetail.LicenseRoleMismatchDetail Constructor
LicenseRoleMismatchDetail.LicenseRoleMismatchDetail Constructor (System.Collections.Generic.Dictionary<Authorit.API.Dto.Reviewer.ReviewParticipantType,System.Collections.Generic.List<int>>)
LicenseRoleMismatchException Class
LicenseRoleMismatchException.FaultDetail Property
LicenseRoleMismatchException.LicenseRoleMismatchException Constructor
LicenseRoleMismatchException.LicenseRoleMismatchException Constructor (System.Collections.Generic.Dictionary<Authorit.API.Dto.Reviewer.ReviewParticipantType,System.Collections.Generic.List<int>>)
LicenseRoleMismatchException.Message Property
LicenseRoleMismatchException.UserIdsByType Property
LicensesExhaustedDetail Class
LicensesExhaustedDetail.LicensesExhaustedDetail Constructor
LicensesExhaustedException Class
LicensesExhaustedException.FaultDetail Property
LicensesExhaustedException.LicensesExhaustedException Constructor
LicensesExhaustedException.Message Property
LockException Class
LockException.FaultDetail Property
LockException.LockException Constructor
LockException.LockException Constructor (int, string)
LockException.Message Property
LockException.ObjectId Property
LockException.Username Property
LockFaultDetail Class
LockFaultDetail.LockFaultDetail Constructor
LockFaultDetail.LockFaultDetail Constructor (int, string)
LockFaultDetail.ObjectId Property
LockFaultDetail.Username Property
ObjectCreatePermissionsException Class
ObjectCreatePermissionsException.FaultDetail Property
ObjectCreatePermissionsException.FolderId Property
ObjectCreatePermissionsException.Message Property
ObjectCreatePermissionsException.ObjectCreatePermissionsException Constructor (int, Authorit.API.Dto.ObjectCreatePermission)
ObjectCreatePermissionsException.RequiredPermissions Property
ObjectCreatePermissionsFaultDetail Class
ObjectCreatePermissionsFaultDetail.FolderId Property
ObjectCreatePermissionsFaultDetail.ObjectCreatePermissionsFaultDetail Constructor
ObjectCreatePermissionsFaultDetail.ObjectCreatePermissionsFaultDetail Constructor (int, Authorit.API.Dto.ObjectCreatePermission)
ObjectCreatePermissionsFaultDetail.RequiredPermissions Property
OperationException Class
OperationException.FaultDetail Property
OperationException.Message Property
OperationException.OperationException Constructor
OperationException.OperationException Constructor (string)
OperationFaultDetail Class
OperationFaultDetail.OperationFaultDetail Constructor
PermissionsException Class
PermissionsException.FaultDetail Property
PermissionsException.FolderId Property
PermissionsException.Message Property
PermissionsException.PermissionsException Constructor
PermissionsException.PermissionsException Constructor (int, Authorit.API.Dto.Permission)
PermissionsException.PermissionsException Constructor (int, int, Authorit.API.Dto.Permission)
PermissionsException.ReleaseStateId Property
PermissionsException.RequiredPermissions Property
PermissionsFaultDetail Class
PermissionsFaultDetail.FolderId Property
PermissionsFaultDetail.PermissionsFaultDetail Constructor
PermissionsFaultDetail.PermissionsFaultDetail Constructor (int, Authorit.API.Dto.Permission)
PermissionsFaultDetail.PermissionsFaultDetail Constructor (int, int, Authorit.API.Dto.Permission)
PermissionsFaultDetail.ReleaseStateId Property
PermissionsFaultDetail.RequiredPermissions Property
ReadOnlyException Class
ReadOnlyException.FaultDetail Property
ReadOnlyException.Message Property
ReadOnlyException.ReadOnlyException Constructor
ReadOnlyFaultDetail Class
ReadOnlyFaultDetail.ReadOnlyFaultDetail Constructor
UnexpectedException Class
UnexpectedException.FaultDetail Property
UnexpectedException.Message Property
UnexpectedException.OriginalMessage Property
UnexpectedException.OriginalSource Property
UnexpectedException.OriginalStackTrace Property
UnexpectedException.UnexpectedException Constructor
UnexpectedException.UnexpectedException Constructor (System.Exception)
UnexpectedFaultDetail Class
UnexpectedFaultDetail.OriginalMessage Property
UnexpectedFaultDetail.OriginalSource Property
UnexpectedFaultDetail.OriginalStackTrace Property
UnexpectedFaultDetail.UnexpectedFaultDetail Constructor
UnexpectedFaultDetail.UnexpectedFaultDetail Constructor (System.Exception)
ValidationException Class
ValidationException.FaultDetail Property
ValidationException.FieldName Property
ValidationException.ValidationException Constructor
ValidationException.ValidationException Constructor (string)
ValidationException.ValidationException Constructor (string, string)
ValidationException.ValidationException Constructor (string, string, string)
ValidationException.Value Property
ValidationFaultDetail Class
ValidationFaultDetail.FieldName Property
ValidationFaultDetail.ValidationFaultDetail Constructor
ValidationFaultDetail.ValidationFaultDetail Constructor (string, string)
ValidationFaultDetail.Value Property
Authorit.API.Security Namespace
AuthenticationType Enumeration
AuthenticationType.Basic Value
AuthenticationType.IntegratedActiveDirectory Value
AuthenticationType.RemoteActiveDirectory Value
UserCredentials Class
UserCredentials() Constructor
UserCredentials(string) Constructor
UserCredentials(string, string) Constructor
UserCredentials(string, string, string, Authorit.API.Security.AuthenticationType) Constructor
UserCredentials(string, string, string, string, Authorit.API.Security.AuthenticationType) Constructor
UserCredentials.AuthenticationType Property
UserCredentials.Domain Property
UserCredentials.Equals(object) Method
UserCredentials.GetAuthToken(string) Method
UserCredentials.GetSchema() Method
UserCredentials.LibraryAlias Property
UserCredentials.Password Property
UserCredentials.ReadXml(System.Xml.XmlReader) Method
UserCredentials.ToString() Method
UserCredentials.UserCredentials(string, string, string) Constructor
UserCredentials.Username Property
UserCredentials.WriteXml(System.Xml.XmlWriter) Method
Authorit.API.Services Namespace
Authentication Class
Authentication.Authentication() Constructor
Authentication.IsLoggedIn() Method
Authentication.Login(string, string, string) Method
Authentication.LoginEx(string, string, string, Authorit.API.Dto.AuthorITModule) Method
Authentication.LoginWithActiveDirectory(string) Method
Authentication.LoginWithActiveDirectoryEx(string, Authorit.API.Dto.AuthorITModule) Method
Authentication.LoginWithRemoteActiveDirectory(string, string, string) Method
Authentication.LoginWithRemoteActiveDirectoryEx(string, string, string, Authorit.API.Dto.AuthorITModule) Method
Authentication.Logout() Method
Book Class
Book() Constructor
Book.Create(Authorit.API.Dto.Book) Method
Book.Get(int) Method
Book.Update(Authorit.API.Dto.Book) Method
File Class
File() Constructor
File.Create(Authorit.API.Dto.File) Method
File.Get(int) Method
File.GetConvertedContent(int, Authorit.API.Dto.OutputType) Method
File.GetConvertedContentResized(int, Authorit.API.Dto.OutputType, int, int) Method
File.GetSourceContent(int, Authorit.API.Dto.OutputType) Method
File.GetSourceContentResized(int, Authorit.API.Dto.OutputType, int, int) Method
File.SetSourceContent(int, byte[], string) Method
File.Update(Authorit.API.Dto.File) Method
Folder Class
Folder.CheckSubfolderExists Function (int, string)
Folder.Create Function (int, string)
Folder.Delete Function (int)
Folder.EnsureExists Function (int, string)
Folder.Folder Constructor
Folder.Get Function (int)
Folder.GetByGuid Function (System.Guid)
Folder.GetByName Function (string)
Folder.GetByParentAndName Function (int, string)
Folder.GetChildren Function (int)
Folder.GetGuidForId Function (int)
Folder.GetIdForGuid Function (System.Guid)
Folder.GetPathToFolder Function (int)
Folder.IsValidFolderId Function (int, bool)
Folder.Move Function (int, int)
Folder.Rename Function (int, string)
Hyperlink Class
Hyperlink.Create Function (Authorit.API.Dto.Hyperlink)
Hyperlink.Get Function (int)
Hyperlink.Hyperlink Constructor
Hyperlink.Update Function (Authorit.API.Dto.Hyperlink)
Library Class
Library() Constructor
Library.GetInformation() Method
Library.GetOptions() Method
Licensing Class
Licensing.GetReviewerLicenses() Method
Licensing.IsLicensedForLive() Method
Licensing.IsLicensedForReviewer() Method
Localization Class
Localization.CancelTranslationJob Function (int)
Localization.ExportTranslationJob Function (int)
Localization.Get Function (int)
Localization.GetAll Function
Localization.GetAllTranslationJobs Function
Localization.GetTranslationJob Function (int)
Localization.Localization Constructor
ObjectCommon Class
ObjectCommon.ApplyTemplate(int, int) Method
ObjectCommon.ChangeReleaseState(int, int) Method
ObjectCommon.ChangeReleaseStateMultiple(System.Collections.Generic.IList<int>, int) Method
ObjectCommon.CheckExists(int) Method
ObjectCommon.CheckExistsByGuid(System.Guid) Method Summary
ObjectCommon.CheckExistsWithObjectType(int, Authorit.API.Dto.ObjectType) Method
ObjectCommon.Create(Authorit.API.Dto.ObjectType, string, int, int) Method
ObjectCommon.CreateVersion(int) Method
ObjectCommon.Delete(int) Method
ObjectCommon.DeleteMultiple(System.Collections.Generic.IList<int>) Method
ObjectCommon.Duplicate(int) Method
ObjectCommon.GetGuidForId(int) Method
ObjectCommon.GetHistory(int, bool) Method
ObjectCommon.GetIdForGuid(System.Guid) Method
ObjectCommon.GetLockInformation(int) Method
ObjectCommon.GetObjectBrief(int) Method
ObjectCommon.GetObjectBriefByGuid(System.Guid) Method
ObjectCommon.GetObjectBriefs(System.Collections.Generic.IList<int>) Method
ObjectCommon.GetObjectsInFolder(int, Authorit.API.Dto.ObjectListSort, Authorit.API.Dto.SortDirection) Method
ObjectCommon.GetRelated(int, Authorit.API.Dto.ObjectRelationship) Method
ObjectCommon.GetTemplates(Authorit.API.Dto.ObjectType, bool) Method
ObjectCommon.GetTemplatesForObject(int) Method
ObjectCommon.GetXml(int) Method
ObjectCommon.GetXmlAsDocument(int) Method
ObjectCommon.GetXmlFromHistory(int, int) Method
ObjectCommon.IsVariantParent(int) Method
ObjectCommon.Lock(int) Method
ObjectCommon.LockMultiple(System.Collections.Generic.IList<int>) Method
ObjectCommon.Move Function (int, int)
ObjectCommon.MoveMultiple Function (System.Collections.Generic.IList<int>, int)
ObjectCommon() Constructor
ObjectCommon.RenewLocks() Method
ObjectCommon.Replace(int, int) Method
ObjectCommon.SaveXml Function (string, bool, bool)
ObjectCommon.Search Function (System.Collections.Generic.IList<Authorit.API.Dto.ObjectSearchCriteria>, Authorit.API.Dto.ObjectListSort, Authorit.API.Dto.SortDirection)
ObjectCommon.SetActiveVersion Function (int)
ObjectCommon.Unlock Function (int)
ObjectCommon.UnlockMultiple Function (System.Collections.Generic.IList<int>)
ObjectCommon.UpdateObjectBrief Function (Authorit.API.Dto.ObjectBrief)
Permissions Class
Permissions.CheckObjectCreatePermissions Function (int, Authorit.API.Dto.ObjectCreatePermission)
Permissions.CheckPermissionsForFolder Function (int, Authorit.API.Dto.Permission)
Permissions.CheckPermissionsForFolderAndReleaseState Function (int, int, Authorit.API.Dto.Permission)
Permissions.CheckPermissionsForObject Function (int, Authorit.API.Dto.Permission)
Permissions.GetObjectCreatePermissions Function (int)
Permissions.GetPermissionsForFolder Function (int)
Permissions.GetPermissionsForFolderAndReleaseState Function (int, int)
Permissions.GetPermissionsForObject Function (int)
Permissions.GetPermissionsForReleaseState Function (int)
Permissions.Permissions Constructor
Permissions.TestObjectCreatePermissions Function (Authorit.API.Dto.ObjectCreatePermission, Authorit.API.Dto.ObjectCreatePermission)
Permissions.TestPermissions Function (Authorit.API.Dto.Permission, Authorit.API.Dto.Permission)
Publishing Class
Publishing.CancelJob Function (int)
Publishing.CheckPublishingServerConfigured Function
Publishing.CreatePublishingServerJob Function (int, int, Authorit.API.Dto.PublishPriority, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>)
Publishing.GetJob Function (int)
Publishing.GetProfilesForBook Function (int)
Publishing.GetPublishingServerPath Function
Publishing.GetPublishingServerUrl Function
Publishing.IsVariableAssignmentRequired Function (int, System.Collections.Generic.IList<int>)
Publishing.Publishing Constructor
Publishing.SearchJobs Function (System.DateTime, System.DateTime, Authorit.API.Dto.PublishJobUserSearchOption, int, int)
ReleaseState Class
ReleaseState.Get(int) Method
ReleaseState.GetAll() Method
ReleaseState.GetByGuid(Guid) Method
ReleaseState.GetGuidForId(int) Method
ReleaseState.GetIdForGuid(Guid) Method
ReleaseState.IsValidReleaseStateId(int) Method
ReleaseState() Constructor
ServiceBase Class
ServiceBase.GetServiceInstance Function
ServiceBase.IsReadOnlyMode Property
StructuredAuthoring Class
StructuredAuthoring.GetEnforcedReleaseStatesForObject Function (int)
StructuredAuthoring.GetEnforcedReleaseStatesForStructure Function (int)
StructuredAuthoring.GetStructure Function (int)
StructuredAuthoring.StructuredAuthoring Constructor
StructuredAuthoring.TestValidateObject Function (int, int)
StructuredAuthoring.ValidateBookContents Function (int, System.Collections.Generic.IList<Authorit.API.Dto.BookTocEntry>)
StructuredAuthoring.ValidateTopicText Function (int, string)
Style Class
Style.GetDefaultCharacterStyle Function
Style.GetDefaultParagraphStyle Function
Style.GetStyleSheet Function
Style.Style Constructor
Topic Class
Topic.Create Function (Authorit.API.Dto.Topic)
Topic.Get Function (int)
Topic.GetResolvedTopicTextXml(int, int) Method
Topic.GetTopicTextXml Function (int)
Topic.GetTopicXhtml Function (int)
Topic.SaveTopicTextFromXml Function (int, string)
Topic.Topic Constructor
Topic.Update Function (Authorit.API.Dto.Topic)
UserAccount Class
UserAccount.ChangePassword(int, string) Method
UserAccount.CreateGroup(Authorit.API.Dto.Group) Method
UserAccount.CreateUser(Authorit.API.Dto.UserAccount) Method
UserAccount.DeleteGroup(int) Method
UserAccount.DeleteUser Function (int)
UserAccount.GetGroup Function (int)
UserAccount.GetGroupByName Function (string)
UserAccount.GetGroupMembers Function (int)
UserAccount.GetGroups Function
UserAccount.GetLastLogin Function (int)
UserAccount.GetRecentLogonFailures Function (int)
UserAccount.GetUser Function (int)
UserAccount.GetUserByName Function (string)
UserAccount.GetUsers Function
UserAccount.GetUsersGroups(int) Method
UserAccount.ResetLogonFailures Function (int)
UserAccount.SetUsersGroups Function (int, System.Collections.Generic.IList<int>)
UserAccount.UpdateGroup Function (Authorit.API.Dto.Group)
UserAccount.UpdateUser Function (Authorit.API.Dto.UserAccount)
UserAccount() Constructor
Variable Class
Variable() Constructor
Variable.Assign(Authorit.API.Dto.VariableAssignment) Method
Variable.AssignMultiple(System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.CheckAssignmentExists(Authorit.API.Dto.VariableAssignment) Method
Variable.CheckVariantExists(int, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.CreateVariant(int, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.Get(int) Method
Variable.GetAll() Method
Variable.GetAssignment(int, int) Method
Variable.GetAssignmentByName(int, string) Method
Variable.GetAssignments(int) Method
Variable.GetByName(string) Method
Variable.GetVariantCriteria(int) Method
Variable.GetVariantCriteriaToAssignForPublishing(int, int) Method
Variable.RemoveVariantAssociation(int) Method
Variable.SearchByName(string, bool) Method
Variable.SetAssignments(System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Xtend Class
Xtend.GetParagraphHighlightColor Function (string)
Xtend.GetParagraphHighlightColorInTopic Function (string, int)
Xtend.GetSuggestionHtml Function (int, int, bool)
Xtend.GetSuggestions Function (string)
Xtend.GetSuggestionsInTopic Function (string, int)
Xtend.GetTopicDetails Function (int, bool)
Xtend.GetTopicsDetails Function (int[], bool)
Xtend.Xtend Constructor
Apache Server Application Programming Interface Reference
Server Application Programming Server Data Transfer Objects
BaseObject DTO
BaseObject.BasedOnDescription Property
BaseObject.BasedOnId Property
BaseObject.Description Property
BaseObject.FolderId Property
BaseObject.Guid Property
BaseObject.IsStructureTemplate Property
BaseObject.IsTemplate Property
BaseObject.ModifiedBy Property
BaseObject.ModifiedDate Property
BaseObject.ObjectCode Property
BaseObject.ObjectId Property
BaseObject.ObjectType Property
BaseObject.ReleaseStateId Property
BaseObject.VariantParentId Property
BaseObject.Version Property
Book DTO
Book.HelpCitation Property
Book.HelpCompression Property
Book.HelpCopyright Property
Book.HelpFileName Property
Book.HelpLinkIncludeFile Property
Book.HelpLinkPrefix Property
Book.HelpLinkTopicOffset Property
Book.HelpMacro Property
Book.HelpTitle Property
Book.IncludeInHelp Property
Book.IncludeInPrint Property
Book.IncludeInWeb Property
Book.ObjectType Property
Book.PrintByLine Property
Book.PrintSubTitle Property
Book.PrintSuperTitle Property
Book.PrintTitle Property
Book.PrintVersion Property
Book.PrintWordTemplate Property
Book.TableOfContents Property
Book.WebAdditionalFiles Property
Book.WebBaseFontSize Property
Book.WebBaseUrl Property
Book.WebByLine Property
Book.WebFramesetTemplate Property
Book.WebSuperTitle Property
Book.WebTitle Property
Book.WebVersion Property
BookTocEntry DTO
BookTocEntry.ObjectId Property
BookTocEntry.Children Property
File DTO
File.HelpBitmapAlignment Property
File.HelpBitmapTransparent Property
File.HelpDirectory Property
File.HelpFileName Property
File.HelpOutputFormat Property
File.HelpParagraphStyleId Property
File.HelpScaleHeight Property
File.HelpScaleWidth Property
File.HelpSizeHeight Property
File.HelpSizeWidth Property
File.HelpSizingMethod Property
File.HelpSourceType Property
File.HelpVideoAutoPlay Property
File.HelpVideoAutoRepeat Property
File.HelpVideoShowMenuButton Property
File.HelpVideoShowPlayBar Property
File.HyperlinkId Property
File.IncludeInHelp Property
File.IncludeInPrint Property
File.IncludeInWeb Property
File.ObjectType Property
File.PrintBorderBottom Property
File.PrintBorderLeft Property
File.PrintBorderRight Property
File.PrintBorderTop Property
File.PrintCaption Property
File.PrintCaptionPosition Property
File.PrintDirectory Property
File.PrintFileName Property
File.PrintLabelType Property
File.PrintOutputFormat Property
File.PrintParagraphStyleId Property
File.PrintScaleHeight Property
File.PrintScaleWidth Property
File.PrintSizeHeight Property
File.PrintSizeWidth Property
File.PrintSizingMethod Property
File.PrintSourceType Property
File.WebAdditionalFiles Property
File.WebAlignment Property
File.WebAlternateText Property
File.WebBorder Property
File.WebDirectory Property
File.WebFileName Property
File.WebImageMap Property
File.WebOutputFormat Property
File.WebSizeHeight Property
File.WebSizeWidth Property
File.WebSourceType Property
File.WebSpacingHorizontal Property
File.WebSpacingVertical Property
File.WebStartVideo Property
File.WebVideoControls Property
File.WebVideoReplay Property
File.WebVideoReplayAmount Property
Folder DTO
Folder.FolderId Property
Folder.Name Property
Folder.ParentFolderId Property
Folder.Guid Property
Folder.HasChildren Property
Group DTO
Group.GroupId Property
Group.Name Property
Group.ActiveDirectoryGroup Property
Hyperlink DTO
Hyperlink.HelpLinkIncludeButton Property
Hyperlink.HelpLinkRemoveUnderline Property
Hyperlink.HelpLinkType Property
Hyperlink.HelpLinkWindow Property
Hyperlink.IncludeInHelp Property
Hyperlink.IncludeInPrint Property
Hyperlink.IncludeInWeb Property
Hyperlink.ObjectType Property
Hyperlink.PrintCrossReferenceBrackets Property
Hyperlink.PrintCrossReferenceIncludeHeading Property
Hyperlink.PrintCrossReferenceIncludePageNumber Property
Hyperlink.PrintCrossReferenceIncludePageNumberText Property
Hyperlink.PrintCrossReferenceText Property
Hyperlink.PrintFootnoteCustom Property
Hyperlink.PrintFootnoteNumberFormat Property
Hyperlink.PrintFootnoteNumberType Property
Hyperlink.PrintLinkType Property
Hyperlink.TopicTargets Property
Hyperlink.WebHelpPopupFontName Property
Hyperlink.WebHelpPopupFontSize Property
Hyperlink.WebHelpPopupMarginsHorizontal Property
Hyperlink.WebHelpPopupMarginsVertical Property
Hyperlink.WebLinkType Property
Hyperlink.WebPopupDHTMLStyleId Property
Hyperlink.WebPopupHeight Property
Hyperlink.WebPopupPositionLeft Property
Hyperlink.WebPopupPositionTop Property
Hyperlink.WebPopupWidth Property
Hyperlink.WebTargets Property
Hyperlink.WebWindowName Property
Hyperlink.WebWindowResizable Property
Hyperlink.WebWindowShowToolbar Property
Hyperlink.WebWindowStatusVisible Property
Hyperlink.WebWindowUseJavaScript Property
HyperlinkWebTarget DTO
HyperlinkWebTarget.Name Property
HyperlinkWebTarget.Description Property
LibraryInformation DTO
LibraryOptions DTO
LibraryOptions.FileObjectThumbnailFolderIds Property
Localization DTO
LoginResponse DTO
LoginResponse.Result Property
LoginResponse.Token Property
ObjectBrief DTO
ObjectHistoryItem DTO
ObjectLockInformation DTO
ObjectLockInformation.IsCurrentSession Property
ObjectLockInformation.ObjectId Property
ObjectLockInformation.UserName Property
ObjectSearchCriteria DTO
ObjectSearchCriteria.Field Property
ObjectSearchCriteria.Value Property
PublishingJob DTO
ReleaseState DTO
ReviewerLicenses DTO
ReviewerLicenses.TotalLicenses Property
ReviewerLicenses.LicensedReviewers Property
RoleProfile DTO
StructureRule DTO
StructureTableCellRule DTO
Topic DTO
HelpHeading Property
HelpHeadingStyleId Property
HelpIncludeInBrowseSequence Property
HelpMacroId Property
HelpNonScrolling Property
HelpStartNewBrowseSequence Property
HelpTocDisplay Property
HelpTocMacroId Property
HelpWindowId Property
IncludeInHelp Property
IncludeInPrint Property
IncludeInWeb Property
ObjectType Property
PrintBreak
PrintHeading Property
PrintHeadingAutoNumberStyle Property
PrintHeadingStyleId Property
PrintSuperHeading Property
WebFilename Property
WebHeading Property
WebMediaId Property
WebStartNewPage Property
WebTitle Property
TranslationJob DTO
UserAccount DTO
Variable DTO
VariableAssignment DTO
XtendSuggestedTopic DTO
XtendSuggestion DTO
Server Application Programming Server Enumerations
AuthorITModule Enumeration
AuthorITModule.Administrator Value
AuthorITModule.Editor Value
AuthorITModule.LocalizationManager Value
AuthorITModule.Reviewer Value
FileBorderStyle Enumeration
FileBorderStyle.Dashed0_75pt Value
FileBorderStyle.Dotted0_75pt Value
FileBorderStyle.Double0_75pt Value
FileBorderStyle.Double1_5 Value
FileBorderStyle.Double2_25pt Value
FileBorderStyle.None Value
FileBorderStyle.Solid0_75pt Value
FileBorderStyle.Solid1_5pt Value
FileBorderStyle.Solid2_25pt Value
FileBorderStyle.Solid3pt Value
FileBorderStyle.Solid4_5pt Value
FileBorderStyle.Solid6pt Value
FileCaptionPosition Enumeration
FileCaptionPosition.Above Value
FileCaptionPosition.Below Value
FileHelpBitmapAlignment Enumeration
FileHelpBitmapAlignment.LeftMargin Value
FileHelpBitmapAlignment.RightMargin Value
FileHelpBitmapAlignment.TextCharacter Value
FileHelpSourceType Enumeration
FileHelpSourceType.Embedded Value
FileHelpSourceType.LinkedOle Value
FileHelpSourceType.LinkedPicture Value
FileHelpSourceType.LinkedRtf Value
FileHelpSourceType.LinkedUrl Value
FileHelpSourceType.LinkedVideo Value
FileLabelType Enumeration
FileLabelType.Equation Value
FileLabelType.Figure Value
FileLabelType.Table Value
FileOutputFormat Enumeration
FileOutputFormat.Bmp Value
FileOutputFormat.Eps Value
FileOutputFormat.Gif Value
FileOutputFormat.Jpeg Value
FileOutputFormat.Png Value
FileOutputFormat.Source Value
FileOutputFormat.Tiff Value
FileOutputFormat.Wmf Value
FilePrintSourceType Enumeration
FilePrintSourceType.Embedded Value
FilePrintSourceType.LinkedDocument Value
FilePrintSourceType.LinkedOle Value
FilePrintSourceType.LinkedPicture Value
FilePrintSourceType.LinkedUrl Value
FileSizingMethod Enumeration
FileSizingMethod.Scale Value
FileSizingMethod.Size Value
FileWebAlignment Enumeration
FileWebAlignment.Bottom Value
FileWebAlignment.Left Value
FileWebAlignment.Middle Value
FileWebAlignment.Right Value
FileWebAlignment.Top Value
FileWebSourceType Enumeration
FileWebSourceType.Embedded Value
FileWebSourceType.LinkedHtml Value
FileWebSourceType.LinkedPicture Value
FileWebSourceType.LinkedUrl Value
FileWebSourceType.LinkedVideo Value
FileWebStartVideo Enumeration
FileWebStartVideo.Both Value
FileWebStartVideo.Manual Value
FileWebStartVideo.MouseOver Value
FileWebStartVideo.Open Value
FileWebVideoReplay Enumeration
FileWebVideoReplay.Continuous Value
FileWebVideoReplay.Specific Value
HeadingAutoNumberStyle Enumeration
HeadingAutoNumberStyle.AlphabeticalLowerCase Value
HeadingAutoNumberStyle.AlphabeticalUpperCase Value
HeadingAutoNumberStyle.Digits Value
HeadingAutoNumberStyle.DigitsText Value
HeadingAutoNumberStyle.None Value
HeadingAutoNumberStyle.Ordinals Value
HeadingAutoNumberStyle.OrdinalsAbbreviated Value
HeadingAutoNumberStyle.RomanLowerCase Value
HeadingAutoNumberStyle.RomanUpperCase Value
HelpCompression Enumeration
HelpCompression.HallOnText Value
HelpCompression.Maximum Value
HelpCompression.None Value
HelpCompression.PhraseOnText Value
HelpCompression.RLEOnBitmaps Value
HelpCompression.ZeckOnBitmaps Value
HelpCompression.ZeckOnText Value
HelpLinkType Enumeration
HelpLinkType.Default Value
HelpLinkType.Popup Value
HelpLinkType.Window Value
HelpTocDisplayType Enumeration
HelpTocDisplayType.DefaultWindow Value
HelpTocDisplayType.ExecuteMacro Value
HelpTocDisplayType.HeadingOnly Value
HelpTocDisplayType.Hide Value
HelpTocDisplayType.Popup Value
ListType Enumeration
ListType.Bulleted Value
ListType.ListContinue Value
ListType.NotList Value
ListType.Numbered Value
LoginResult Enumeration
LoginResult.FailureDatabaseNotFound Value
LoginResult.FailureError Value
LoginResult.FailureIncorrectUsernameOrPassword Value
LoginResult.FailureLibraryFutureVersion Value
LoginResult.FailureLibraryOpen Value
LoginResult.FailureLibraryUpgradeNeeded Value
LoginResult.FailureLicensing Value
LoginResult.Success Value
ObjectCreatePermission Enumeration
ObjectCreatePermission.All Value
ObjectCreatePermission.BookCreate Value
ObjectCreatePermission.BookCreateTemplate Value
ObjectCreatePermission.FileCreate Value
ObjectCreatePermission.FileCreateTemplate Value
ObjectCreatePermission.GlossaryCreate Value
ObjectCreatePermission.GlossaryCreateTemplate Value
ObjectCreatePermission.HyperlinkCreate Value
ObjectCreatePermission.HyperlinkCreateTemplate Value
ObjectCreatePermission.IndexCreate Value
ObjectCreatePermission.IndexCreateTemplate Value
ObjectCreatePermission.IndexEntryCreate Value
ObjectCreatePermission.IndexEntryCreateTemplate Value
ObjectCreatePermission.MacroCreate Value
ObjectCreatePermission.MacroCreateTemplate Value
ObjectCreatePermission.MediaCreate Value
ObjectCreatePermission.MediaCreateTemplate Value
ObjectCreatePermission.None Value
ObjectCreatePermission.PublishProfileCreate Value
ObjectCreatePermission.PublishProfileCreateTemplate Value
ObjectCreatePermission.StyleCreate Value
ObjectCreatePermission.StyleCreateTemplate Value
ObjectCreatePermission.TOCCreate Value
ObjectCreatePermission.TOCCreateTemplate Value
ObjectCreatePermission.TOFCreate Value
ObjectCreatePermission.TOFCreateTemplate Value
ObjectCreatePermission.TopicCreate Value
ObjectCreatePermission.TopicCreateTemplate Value
ObjectCreatePermission.TPageCreate Value
ObjectCreatePermission.TPageCreateTemplate Value
ObjectHistoryModifiedType Enumeration
ObjectHistoryXmlStatus Enumeration
ObjectHistoryXmlStatus.Archived Value
ObjectHistoryXmlStatus.InDatabase Value
ObjectHistoryXmlStatus.None Value
ObjectListSort Enumeration
ObjectListSort.BasedOn Value
ObjectListSort.CreatedDate Value
ObjectListSort.Description Value
ObjectListSort.ModifiedByDate Value
ObjectListSort.ModifiedByUsername Value
ObjectListSort.ObjectCode Value
ObjectListSort.ObjectId Value
ObjectListSort.ObjectType Value
ObjectListSort.ReleaseState Value
ObjectListSort.StructureValidity Value
ObjectListSort.Version Value
ObjectRelationship Enumeration
ObjectRelationship.UsedBy Value
ObjectRelationship.Uses Value
ObjectSearchField Enumeration
ObjectSearchField.BasedOnDescription Value
ObjectSearchField.BasedOnId Value
ObjectSearchField.ContainingText Value
ObjectSearchField.Description Value
ObjectSearchField.FolderId Value
ObjectSearchField.InBookId Value
ObjectSearchField.IsTemplate Value
ObjectSearchField.ModifiedFromDate Value
ObjectSearchField.ModifiedToDate Value
ObjectSearchField.ObjectCode Value
ObjectSearchField.ObjectType Value
ObjectSearchField.ReleaseStateId Value
ObjectSearchField.ResolveSubBooks Value
ObjectSearchField.VariableAssignment Value
ObjectStatus Enumeration
ObjectStatus.Active Value
ObjectStatus.Inactive Value
ObjectStatus.Redundant Value
ObjectType Enumeration
ObjectType.Book Value
ObjectType.File Value
ObjectType.Glossary Value
ObjectType.Hyperlink Value
ObjectType.Index Value
ObjectType.IndexEntry Value
ObjectType.Macro Value
ObjectType.Media Value
ObjectType.PublishProfile Value
ObjectType.Style Value
ObjectType.TableOfContents Value
ObjectType.TableOfFigures Value
ObjectType.TitlePage Value
ObjectType.Topic Value
OutputType Enumeration
OutputType.Help Value
OutputType.Print Value
OutputType.Web Value
Permission Enumeration
PrintBreakType Enumeration
PrintBreakType.Column Value
PrintBreakType.None Value
PrintBreakType.Page Value
PrintBreakType.Section Value
PrintCrossReferenceIncludeHeading Enumeration
PrintCrossReferenceIncludeHeading.Always Value
PrintCrossReferenceIncludeHeading.Never Value
PrintCrossReferenceIncludeHeading.WhenDifferent Value
PrintFootnoteNumberFormat Enumeration
PrintFootnoteNumberFormat.AlphabeticalLowerCase Value
PrintFootnoteNumberFormat.AlphabeticalUpperCase Value
PrintFootnoteNumberFormat.Digits Value
PrintFootnoteNumberFormat.RomanLowerCase Value
PrintFootnoteNumberFormat.RomanUpperCase Value
PrintFootnoteNumberType Enumeration
PrintFootnoteNumberType.Automatic Value
PrintFootnoteNumberType.Custom Value
PrintLinkType Enumeration
PrintLinkType.CrossReference Value
PrintLinkType.EmbeddedBlock Value
PrintLinkType.EmbeddedInline Value
PrintLinkType.FootNote Value
PublishJobUserSearchOption Enumeration
PublishPriority Enumeration
PublishPriority.High
PublishPriority.Low
PublishPriority.Medium
PublishStatus Enumeration
PublishStatus.Cancelled Value
PublishStatus.Completed Value
PublishStatus.Pending Value
PublishStatus.Queued Value
PublishStatus.Started Value
PublishType Enumeration
PublishType.Aspect Value
PublishType.DITA Value
PublishType.HTML Value
PublishType.HTMLHelp Value
PublishType.JavaHelp Value
PublishType.OracleHelp Value
PublishType.PDF Value
PublishType.Website Value
PublishType.WinHelp Value
PublishType.Word Value
PublishType.XHTML Value
PublishType.XML Value
SortDirection Enumeration
StructureRuleSequence Enumeration
StructureRuleType Enumeration
StructureTableCellRuleType Enumeration
StructureValidity Enumeration
StyleType Enumeration
TranslationJobStatus Enumeration
VariableType Enumeration
WebLinkType Enumeration
WebLinkType.Default Value
WebLinkType.ExpandBlock Value
WebLinkType.ExpandInline Value
WebLinkType.NewWindow Value
WebLinkType.PopupClick Value
WebLinkType.PopupHover Value
WebLinkType.PopupNative Value
Server Application Programming Server Services
Authentication Service
Server Application Programming Server IsLoggedIn() Method
Server Application Programming Server Login(String, String, String) Method
Server Application Programming Server LoginEx(String, String, String, AuthorITModule) Method
Server Application Programming Server LoginWithActiveDirectory(String) Method
Server Application Programming Server LoginWithActiveDirectoryEx(String, AuthorITModule) Method
Server Application Programming Server LoginWithRemoteActiveDirectory(String, String, String) Method
Server Application Programming Server LoginWithRemoteActiveDirectoryEx(String, String, String, AuthorITModule) Method
Server Application Programming Server Logout() Method
Book Service
Create(Book) Method
Get(Integer) Method
Update(Book) Method
File Service
Create(File) Method
GetConvertedContent(Integer, OutputType) Method
GetConvertedContentResized(Integer, OutputType, Integer, Integer) Method
GetSourceContent(Integer, OutputType) Method
GetSourceContentResized(Integer, OutputType, Integer, Integer) Method
SetSourceContent(Integer, Byte Array, String) Method
Update(File) Method
Folder Service
CheckSubfolderExists(Integer, String) Method
Create(Integer, String) Method
Delete(Integer) Method
EnsureExists(Integer, String) Method
Get(Integer) Method
GetByGuid(Guid) Method
GetByName(String) Method
GetByParentAndName(Integer, String) Method
GetChildren(Integer) Method
GetGuidForId(Integer) Method
GetIdForGuid(Guid) Method
GetPathToFolder(Integer) Method
IsValidFolderId(Integer, Boolean) Method
Move(Integer, Integer) Method
Rename(Integer, String) Method
Hyperlink Service
Create(Hyperlink) Method
Get(Integer) Method
Update(Hyperlink) Method
Library Service
GetInformation() Method
GetOptions() Method
Localization Service
CancelTranslationJob(Integer) Method
ExportTranslationJob(Integer) Method
GetAll() Method
GetAllTranslationJobs() Method
GetTranslationJob(Integer) Method
ObjectCommon Service
ApplyTemplate(Integer, Integer) Method
ChangeReleaseState(Integer, Integer) Method
ChangeReleaseStateMultiple(Integer List, Integer) Method
CheckExists(Integer) Method
CheckExistsByGuid(Guid) Method
CheckExistsWithObjectType(Integer, ObjectType) Method
Create(ObjectType, String, Integer, Integer) Method
CreateVersion(Integer) Method
Delete(Integer) Method
DeleteMultiple(Integer List) Method
Duplicate(Integer) Method
GetGuidForId(Integer) Method
GetHistory(Integer, Boolean) Method
GetIdForGuid(Guid) Method
GetLockInformation(Integer) Method
GetObjectBrief(Integer) Method
GetObjectBriefByGuid(Guid) Method
GetObjectBriefs(Integer List) Method
GetObjectsInFolder(Integer, ObjectListSort, SortDirection) Method
GetRelated(Integer, ObjectRelationship) Method
GetTemplates(ObjectType, Boolean) Method
GetTemplatesForObject(Integer) Method
GetXml(Integer) Method
GetXmlAsDocument(Integer) Method
GetXmlFromHistory(Integer, Integer) Method
IsVariantParent(Integer) Method
Lock(Integer) Method
LockMultiple(Integer List) Method
Move(Integer, Integer) Method
MoveMultiple(Integer List, Integer) Method
RenewLocks() Method
Replace(Integer, Integer) Method
SaveXml(String, Boolean, Boolean) Method
Search(ObjectSearchCriteria List, ObjectListSort, SortDirection) Method
SetActiveVersion(Integer) Method
Unlock(Integer) Method
UnlockMultiple(Integer List) Method
UpdateObjectBrief(ObjectBrief) Method
Permissions Service
CheckObjectCreatePermissions(Integer, ObjectCreatePermission) Method
CheckPermissionsForFolder(Integer, Permission) Method
CheckPermissionsForFolderAndReleaseState(Integer, Integer, Permission) Method
CheckPermissionsForObject(Integer, Permission) Method
GetObjectCreatePermissions(Integer) Method
GetPermissionsForFolder(Integer) Method
GetPermissionsForFolderAndReleaseState(Integer, Integer) Method
GetPermissionsForObject(Integer) Method
GetPermissionsForReleaseState(Integer) Method
TestObjectCreatePermissions(ObjectCreatePermission, ObjectCreatePermission) Method
TestPermissions(Permission, Permission) Method
Publishing Service
CancelJob(Integer) Method
CheckPublishingServerConfigured() Method
CreatePublishingServerJob(Integer, Integer, PublishPriority, VariableAssignment List) Method
GetJob(Integer) Method
GetProfilesForBook(Integer) Method
GetPublishingServerPath() Method
GetPublishingServerUrl() Method
IsVariableAssignmentRequired(Integer, Integer List) Method
SearchJobs(DateTime, DateTime, PublishJobUserSearchOption, Integer, Integer) Method
ReleaseState Service
Get(Integer) Method
GetAll() Method
GetByGuid(Guid) Method
GetGuidForId(Integer) Method
GetIdForGuid(Guid) Method
IsValidReleaseStateId(Integer) Method
StructuredAuthoring Service
GetEnforcedReleaseStatesForObject(Integer) Method
GetEnforcedReleaseStatesForStructure(Integer) Method
GetStructure(Integer) Method
TestValidateObject(Integer, Integer) Method
ValidateBookContents(Integer, BookTocEntry List) Method
ValidateTopicText(Integer, String) Method
Style Service
GetDefaultCharacterStyle() Method
GetDefaultParagraphStyle() Method
GetStyleSheet() Method
Topic Service
Create(Topic) Method
Get(Integer) Method
GetResolvedTopicTextXml(Integer, Integer) Method
GetTopicTextXml(Integer) Method
GetTopicXhtml(Integer) Method
SaveTopicTextFromXml(Integer, String) Method
Update(Topic) Method
UserAccount Service
ChangePassword(Integer, String) Method
CreateGroup(Group) Method
CreateUser(UserAccount) Method
DeleteGroup(Integer) Method
DeleteUser(Integer) Method
GetGroup(Integer) Method
GetGroupByName(String) Method
GetGroupMembers(Integer) Method
GetGroups() Method
GetLastLogin(Integer) Method
GetRecentLogonFailures(Integer) Method
GetUser(Integer) Method
GetUserByName(String) Method
GetUsers() Method
GetUsersGroups(Integer) Method
ResetLogonFailures(Integer) Method
SetUsersGroups(Integer, Integer List) Method
UpdateGroup(Group) Method
UpdateUser(UserAccount) Method
Variable Service
Assign(VariableAssignment) Method
AssignMultiple(VariableAssignment List) Method
CheckAssignmentExists(VariableAssignment) Method
CheckVariantExists(Integer, VariableAssignment List) Method
CreateVariant(Integer, VariableAssignment List) Method
Get(Integer) Method
GetAll() Method
GetAssignment(Integer, Integer) Method
GetAssignmentByName(Integer, String) Method
GetAssignments(Integer) Method
GetByName(String) Method
GetVariantCriteria(Integer) Method
GetVariantCriteriaToAssignForPublishing(Integer, Integer) Method
RemoveVariantAssociation(Integer) Method
SearchByName(String, Boolean) Method
SetAssignments(VariableAssignment List) Method
Xtend Service
GetParagraphHighlightColor(String) Method
GetParagraphHighlightColorInTopic(String, Integer) Method
GetSuggestionHtml(Integer, Integer, Boolean) Method
GetSuggestions(String) Method
GetSuggestionsInTopic(String, Integer) Method
GetTopicDetails(Integer, Boolean) Method
GetTopicsDetails(Integer Array, Boolean) Method
Author-it API Server Configuration File Reference
APIServerConfig Element
Endpoints Element
Endpoint Element
Libraries Element
Library Element
RequiresApiToken Element
TokenEncryption Element
Author User Interface Controls Reference
Ribbon Control Names
Book Editor Button Names
Edit Ribbon
Layout Ribbon
Publish Ribbon
Review Ribbon
View Ribbon
Main Form Controls
Author Tab
Design Ribbon
Import Ribbon
Manage Ribbon
Publish Ribbon
AuthoritExtensibility Namespace
AitApplicationProxy
AitApplicationProxy() Constructor
AitApplicationProxy.AddPluginToAitEvent(AitEventAddArgs) Method
AitApplicationProxy.AddPluginToDeactivateUI(DeactivateUIAddArgs) Method
AitApplicationProxy.AddPluginToObjectContextMenu(ContextMenuAddArgs) Method
AitApplicationProxy.AddPluginToTextEditorMenu(TextEditorAddArgs) Method
AitApplicationProxy.AddPluginToToolbar(ToolbarAddArgs) Method
AitApplicationProxy.AitEventAdd Event
AitApplicationProxy.ContextMenuAdd Event
AitApplicationProxy.DeactivateUIAdd Event
AitApplicationProxy.DeactivateUIControl Event
AitApplicationProxy.InsertText(TextInsertArgs) Method
AitApplicationProxy.LibraryRefresh Event
AitApplicationProxy.ObjectRefresh Event
AitApplicationProxy.PluginFolder Property
AitApplicationProxy.RefreshLibrary(LibraryRefreshArgs) Method
AitApplicationProxy.RefreshObject(ObjectRefreshArgs) Method
AitApplicationProxy.TextEditorAdd Event
AitApplicationProxy.TextInsert Event
AitApplicationProxy.ToolbarAdd Event
AitApplicationProxy.UIControlDeactivate(DeactivateUIControlArgs) Method
AitEventAddArgs
AitEventAddArgs() Constructor
AitEventAddArgs.EventType Property
AitEventAddArgs.OnAitEvent Property
AitEventAddArgs.PluginFolderPath Property
AitEventAddArgs.PluginName Property
AitEventAddHandler Delegate
AitEventHandler Delegate
AitEventType Enumeration
AfterLogin
AfterObjectFormOpen
AfterObjectFormSave
AfterReleaseStateChange
AfterTemplateChange
BeforeLogin
BeforeObjectFormOpen
BeforeObjectFormSave
BeforePublish
BeforeReleaseStateChange
BeforeTemplateChange
AitEventType.OnFolderSelect Value
AitEventType.OnObjectSelect Value
AuthoritEventArgs
AuthoritEventArgs() Constructor
AuthoritEventArgs.Cancel Property
AuthoritEventArgs.CurrentBookId Property
AuthoritEventArgs.CurrentFolderId Property
AuthoritEventArgs.CurrentFolderPath Property
AuthoritEventArgs.CurrentTopicId Property
AuthoritEventArgs.LibraryPath Property
AuthoritEventArgs.Password Property
AuthoritEventArgs.PublishProfileID Property
AuthoritEventArgs.SelectedObjectBasedOnID Property
AuthoritEventArgs.SelectedObjectID Property
AuthoritEventArgs.SelectedObjectIDs Property
AuthoritEventArgs.SelectedObjectIsLocked Property
AuthoritEventArgs.SelectedObjectType Property
AuthoritEventArgs.SelectedObjectXML Property
AuthoritEventArgs.SelectedText Property
AuthoritEventArgs.SqlDatabase Property
AuthoritEventArgs.SqlPassword Property
AuthoritEventArgs.SqlServername Property
AuthoritEventArgs.SqlUsername Property
AuthoritEventArgs.TargetReleaseStateID Property
AuthoritEventArgs.TargetTemplateID Property
AuthoritEventArgs.Username Property
ContextMenuAddArgs
ContextMenuAddArgs() Constructor
ContextMenuAddArgs.IconImage Property
ContextMenuAddArgs.IconResourceName Property
ContextMenuAddArgs.OnClick Property
ContextMenuAddArgs.PluginFolderPath Property
ContextMenuAddArgs.PluginName Property
ContextMenuAddArgs.SelectedObjectsMax Property
ContextMenuAddArgs.SelectedObjectsMin Property
ContextMenuAddArgs.SelectedObjectsSameType Property
ContextMenuAddArgs.SelectedObjectsTemplateNames Property
ContextMenuAddArgs.SelectedObjectsTypes Property
ContextMenuAddHandler Delegate
ContextMenuClickHandler Delegate
DeactivateUIAddArgs
DeactivateUIAddArgs() Constructor
DeactivateUIAddArgs.OnClick Property
DeactivateUIAddArgs.PluginFolderPath Property
DeactivateUIAddArgs.PluginName Property
DeactivateUIAddHandler Delegate
DeactivateUIControlArgs Class
DeactivateUIControlArgs() Constructor
DeactivateUIControlArgs.ControlName Property
DeactivateUIControlArgs.ControlType Property
DeactivateUIControlArgs.DeactivationType Property
DeactivateUIControlArgs.ParentForm Property
DeactivateUIControlHandler Delegate
DeactivateUIEventRaisedHandler Delegate
DeactivationType Enumeration
DeactivationType.Default Value
DeactivationType.Disabled Value
DeactivationType.Hidden Value
IPlugin Interface
LibraryRefreshArgs Class
LibraryRefreshArgs() Constructor
LibraryRefreshArgs.Type Property
LibraryRefreshHandler Delegate
LibraryRefreshType Enumeration
LibraryRefreshType.FolderRefresh Value
ObjectRefreshArgs Class
ObjectRefreshArgs() Constructor
ObjectRefreshArgs.ObjectID
ObjectRefreshArgs.RefreshType
ObjectRefreshHandler Delegate
ObjectType Enumeration
ObjectType.All Value
ObjectType.None Value
ObjectType.Book Value
ObjectType.Topic Value
ObjectType.File Value
ObjectType.TableOfContents Value
ObjectType.TableOfFigures Value
ObjectType.TitlePage Value
ObjectType.Glossary Value
ObjectType.Index Value
ObjectType.Media Value
ObjectType.IndexEntry Value
ObjectType.Hyperlink Value
ObjectType.Macro Value
ObjectType.Style Value
ObjectType.PublishProfile Value
RefreshType Enumeration
RefreshType.ObjectAdded Value
RefreshType.ObjectDeleted Value
RefreshType.ObjectLocked Value
RefreshType.ObjectUnlocked Value
RefreshType.ObjectUpdated Value
SelectionBehaviour Enumeration
SelectionBehaviour.InsertAfter Value
SelectionBehaviour.InsertAtCursor Value
SelectionBehaviour.InsertBefore Value
SelectionBehaviour.Replace Value
TargetForm Enumeration
TargetForm.BookEditor Value
TargetForm.MainForm Value
TextEditorAddArgs Class
TextEditorAddArgs.EnabledObjectTypes Property
TextEditorAddArgs.EnabledWithNoSelection Property
TextEditorAddArgs.EnabledWithSelection Property
TextEditorAddArgs.IconImage Property
TextEditorAddArgs.IconResourceName Property
TextEditorAddArgs.OnClick Property
TextEditorAddArgs.PluginFolderPath Property
TextEditorAddArgs.PluginName Property
TextEditorAddHandler Delegate
TextEditorClick Handler Delegate
TextInsertArgs Class
TextInsertArgs.InsertParagraph Property
TextInsertArgs.ObjectID Property
TextInsertArgs.ObjectType Property
TextInsertArgs.SelectionBehavior Property
TextInsertArgs.Text Property
TextInsertArgs.TopicPaste Property
TextInsertHandler Delegate
ToolbarAddArgs Class
ToolbarAddArgs.IconImage Property
ToolbarAddArgs.IconResourceName Property
ToolbarAddArgs.OnClick Property
ToolbarAddArgs.PluginFolderPath Property
ToolbarAddArgs.PluginName Property
ToolbarAddArgs.TargetButtonName Property
ToolbarAddArgs.TargetForm Property
ToolbarAddArgs.TargetGroupName Property
ToolbarAddArgs.Tooltip Property
ToolbarAddHandler Delegate
ToolbarClickHandler Delegate
UIControlType Enumeration
UIControlType.RibbonTab Value
UIControlType.RibbonGroup Value
UIControlType.RibbonButton Value
UIControlType.ObjectContextMenuItem Value
UIControlType.BookTreeMenuItem Value
Author-it API Class Library Reference
Authorit.API Namespace
ApplicationContext Class
ApplicationContext() Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList) Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList, Authorit.API.ApplicationType) Constructor
ApplicationContext(Authorit.API.Configuration.LibraryConfigurationList, Authorit.API.ApplicationType, bool) Constructor
ApplicationContext.GetServiceInstance<TService>() Method
ApplicationContext.LibrariesConfiguration Property
ApplicationContext.LibraryUtility Property
ApplicationType Enumeration
ApplicationType.AspNet Value
ApplicationType.SingleUser Value
ApplicationType.UserPerThread Value
ApplicationType.Wcf Value
LibraryUtility Class
LibraryUtility.GetTargetLibraryConfiguration(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.GetVersion(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.TestConnection(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryUtility.Upgrade(Authorit.API.Configuration.LibraryConfigurationBase, Authorit.API.Security.UserCredentials) Method
PropertyChangingEventArgs Class
PropertyChangingEventArgs(string, object, object) Constructor
PropertyChangingEventArgs.NewValue Property
PropertyChangingEventArgs.OldValue Property
Authorit.API.Configuration Namespace
JetLibraryConfiguration Class
JetLibraryConfiguration.Description Property
JetLibraryConfiguration.GetSchema() Method
JetLibraryConfiguration() Constructor
JetLibraryConfiguration.JetLibraryConfiguration(string, string) Constructor
JetLibraryConfiguration.LibraryType Property
JetLibraryConfiguration.Path Property
JetLibraryConfiguration.ReadXml(System.Xml.XmlReader) Method
JetLibraryConfiguration.ToString() Method
JetLibraryConfiguration.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationBase Class
LibraryConfigurationBase.Alias Property
LibraryConfigurationBase.AliasChanging Event
LibraryConfigurationBase.Description Property
LibraryConfigurationBase.GetSchema() Method
LibraryConfigurationBase.LibraryType Property
LibraryConfigurationBase.ReadXml(System.Xml.XmlReader) Method
LibraryConfigurationBase.Validate() Method
LibraryConfigurationBase.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationList Class
LibraryConfigurationList() Constructor
LibraryConfigurationList(Authorit.API.Configuration.LibraryConfigurationBase) Constructor
LibraryConfigurationList.Add(Authorit.API.Configuration.LibraryConfigurationBase) Method
LibraryConfigurationList.Aliases Property
LibraryConfigurationList.Clear() Method
LibraryConfigurationList.Contains(string) Method
LibraryConfigurationList.Count Property
LibraryConfigurationList.GetEnumerator() Method
LibraryConfigurationList.GetSchema() Method
LibraryConfigurationList.ReadXml(System.Xml.XmlReader) Method
LibraryConfigurationList.Remove(string) Method
LibraryConfigurationList.ToString() Method
LibraryConfigurationList.WriteXml(System.Xml.XmlWriter) Method
LibraryConfigurationList[int] Property
LibraryConfigurationList[string] Property
LoggingConfiguration Class
LoggingConfiguration() Constructor
LoggingConfiguration(Authorit.API.Configuration.LogLevel, Authorit.API.Configuration.LogLevel) Constructor
LoggingConfiguration.FileLogLevel Property
LoggingConfiguration.GetSchema() Method
LoggingConfiguration.ReadXml(System.Xml.XmlReader) Method
LoggingConfiguration.TraceLogLevel Property
LoggingConfiguration.WriteXml(System.Xml.XmlWriter) Method
LogLevel Enumeration
LogLevel.All Value
LogLevel.Debug Value
LogLevel.Error Value
LogLevel.Fatal Value
LogLevel.Info Value
LogLevel.None Value
LogLevel.Warn Value
SqlServerLibraryConfiguration Class
SqlServerLibraryConfiguration() Constructor
SqlServerLibraryConfiguration(string, string, string) Constructor
SqlServerLibraryConfiguration(string, string, string, string, string) Constructor
SqlServerLibraryConfiguration.ConnectionPoolingEnabled Property
SqlServerLibraryConfiguration.Database Property
SqlServerLibraryConfiguration.Description Property
SqlServerLibraryConfiguration.GetSchema() Method
SqlServerLibraryConfiguration.LibraryType Property
SqlServerLibraryConfiguration.LoginID Property
SqlServerLibraryConfiguration.Password Property
SqlServerLibraryConfiguration.ReadXml(System.Xml.XmlReader) Method
SqlServerLibraryConfiguration.Server Property
SqlServerLibraryConfiguration.ToString() Method
SqlServerLibraryConfiguration.TrustedConnection Property
SqlServerLibraryConfiguration.WriteXml(System.Xml.XmlWriter) Method
Authorit.API.Dto Namespace
AuthorITModule Enumeration
AuthorITModule.Administrator Value
AuthorITModule.Editor Value
AuthorITModule.LocalizationManager Value
AuthorITModule.Reviewer Value
BaseObject Class
BaseObject.BasedOnDescription Property
BaseObject.BasedOnId Property
BaseObject() Constructor
BaseObject.Description Property
BaseObject.FolderId Property
BaseObject.Guid Property
BaseObject.IsStructureTemplate Property
BaseObject.IsTemplate Property
BaseObject.ModifiedBy Property
BaseObject.ModifiedDate Property
BaseObject.ObjectCode Property
BaseObject.ObjectId Property
BaseObject.ObjectType Property
BaseObject.ReleaseStateId Property
BaseObject.VariantParentId Property
BaseObject.Version Property
Book Class
Book() Constructor
Book.HelpCitation Property
Book.HelpCompression Property
Book.HelpCopyright Property
Book.HelpFileName Property
Book.HelpLinkIncludeFile Property
Book.HelpLinkPrefix Property
Book.HelpLinkTopicOffset Property
Book.HelpMacro Property
Book.HelpTitle Property
Book.IncludeInHelp Property
Book.IncludeInPrint Property
Book.IncludeInWeb Property
Book.ObjectType Property
Book.PrintByLine Property
Book.PrintSubTitle Property
Book.PrintSuperTitle Property
Book.PrintTitle Property
Book.PrintVersion Property
Book.PrintWordTemplate Property
Book.TableOfContents Property
Book.WebAdditionalFiles Property
Book.WebBaseFontSize Property
Book.WebBaseUrl Property
Book.WebByLine Property
Book.WebFramesetTemplate Property
Book.WebSuperTitle Property
Book.WebTitle Property
Book.WebVersion Property
BookTocEntry Class
BookTocEntry() Constructor
BookTocEntry.Children Property
BookTocEntry.ObjectId Property
Constants Class
Constants.NoReleaseStateId Property
Constants.RootFolderId Property
File Class
File() Constructor
File.HelpBitmapAlignment Property
File.HelpBitmapTransparent Property
File.HelpDirectory Property
File.HelpFileName Property
File.HelpOutputFormat Property
File.HelpParagraphStyleId Property
File.HelpScaleHeight Property
File.HelpScaleWidth Property
File.HelpSizeHeight Property
File.HelpSizeWidth Property
File.HelpSizingMethod Property
File.HelpSourceType Property
File.HelpVideoAutoPlay Property
File.HelpVideoAutoRepeat Property
File.HelpVideoShowMenuButton Property
File.HelpVideoShowPlayBar Property
File.HyperlinkId Property
File.IncludeInHelp Property
File.IncludeInPrint Property
File.IncludeInWeb Property
File.ObjectType Property
File.PrintBorderBottom Property
File.PrintBorderLeft Property
File.PrintBorderRight Property
File.PrintBorderTop Property
File.PrintCaption Property
File.PrintCaptionPosition Property
File.PrintDirectory Property
File.PrintFileName Property
File.PrintLabelType Property
File.PrintOutputFormat Property
File.PrintParagraphStyleId Property
File.PrintScaleHeight Property
File.PrintScaleWidth Property
File.PrintSizeHeight Property
File.PrintSizeWidth Property
File.PrintSizingMethod Property
File.PrintSourceType Property
File.WebAdditionalFiles Property
File.WebAlignment Property
File.WebAlternateText Property
File.WebBorder Property
File.WebDirectory Property
File.WebFileName Property
File.WebImageMap Property
File.WebOutputFormat Property
File.WebSizeHeight Property
File.WebSizeWidth Property
File.WebSourceType Property
File.WebSpacingHorizontal Property
File.WebSpacingVertical Property
File.WebStartVideo Property
File.WebVideoControls Property
File.WebVideoReplay Property
File.WebVideoReplayAmount Property
FileBorderStyle Enumeration
FileBorderStyle.Dashed0_75pt Value
FileBorderStyle.Dotted0_75pt Value
FileBorderStyle.Double0_75pt Value
FileBorderStyle.Double1_5 Value
FileBorderStyle.Double2_25pt Value
FileBorderStyle.None Value
FileBorderStyle.Solid0_75pt Value
FileBorderStyle.Solid1_5pt Value
FileBorderStyle.Solid2_25pt Value
FileBorderStyle.Solid3pt Value
FileBorderStyle.Solid4_5pt Value
FileBorderStyle.Solid6pt Value
FileCaptionPosition Enumeration
FileCaptionPosition.Above Value
FileCaptionPosition.Below Value
FileHelpBitmapAlignment Enumeration
FileHelpBitmapAlignment.LeftMargin Value
FileHelpBitmapAlignment.RightMargin Value
FileHelpBitmapAlignment.TextCharacter Value
FileHelpSourceType Enumeration
FileHelpSourceType.Embedded Value
FileHelpSourceType.LinkedOle Value
FileHelpSourceType.LinkedPicture Value
FileHelpSourceType.LinkedRtf Value
FileHelpSourceType.LinkedUrl Value
FileHelpSourceType.LinkedVideo Value
FileLabelType Enumeration
FileLabelType.Equation Value
FileLabelType.Figure Value
FileLabelType.Table Value
FileOutputFormat Enumeration
FileOutputFormat.Bmp Value
FileOutputFormat.Eps Value
FileOutputFormat.Gif Value
FileOutputFormat.Jpeg Value
FileOutputFormat.Png Value
FileOutputFormat.Source Value
FileOutputFormat.Tiff Value
FileOutputFormat.Wmf Value
FilePrintSourceType Enumeration
FilePrintSourceType.Embedded Value
FilePrintSourceType.LinkedDocument Value
FilePrintSourceType.LinkedOle Value
FilePrintSourceType.LinkedPicture Value
FilePrintSourceType.LinkedUrl Value
FileSizingMethod Enumeration
FileSizingMethod.Scale Value
FileSizingMethod.Size Value
FileWebAlignment Enumeration
FileWebAlignment.Bottom Value
FileWebAlignment.Left Value
FileWebAlignment.Middle Value
FileWebAlignment.Right Value
FileWebAlignment.Top Value
FileWebSourceType Enumeration
FileWebSourceType.Embedded Value
FileWebSourceType.LinkedHtml Value
FileWebSourceType.LinkedPicture Value
FileWebSourceType.LinkedUrl Value
FileWebSourceType.LinkedVideo Value
FileWebStartVideo Enumeration
FileWebStartVideo.Both Value
FileWebStartVideo.Manual Value
FileWebStartVideo.MouseOver Value
FileWebStartVideo.Open Value
FileWebVideoReplay Enumeration
FileWebVideoReplay.Continuous Value
FileWebVideoReplay.Specific Value
Folder Class
Folder() Constructor
Folder.FolderId Property
Folder.Guid Property
Folder.HasChildren Property
Folder.Name Property
Folder.ParentFolderId Property
Group Class
Group() Constructor
Group.ActiveDirectoryGroup Property
Group.GroupId Property
Group.Name Property
HeadingAutoNumberStyle Enumeration
HeadingAutoNumberStyle.AlphabeticalLowerCase Value
HeadingAutoNumberStyle.AlphabeticalUpperCase Value
HeadingAutoNumberStyle.Digits Value
HeadingAutoNumberStyle.DigitsText Value
HeadingAutoNumberStyle.None Value
HeadingAutoNumberStyle.Ordinals Value
HeadingAutoNumberStyle.OrdinalsAbbreviated Value
HeadingAutoNumberStyle.RomanLowerCase Value
HeadingAutoNumberStyle.RomanUpperCase Value
HelpCompression Enumeration
HelpCompression.HallOnText Value
HelpCompression.Maximum Value
HelpCompression.None Value
HelpCompression.PhraseOnText Value
HelpCompression.RLEOnBitmaps Value
HelpCompression.ZeckOnBitmaps Value
HelpCompression.ZeckOnText Value
HelpLinkType Enumeration
HelpLinkType.Default Value
HelpLinkType.Popup Value
HelpLinkType.Window Value
HelpTocDisplayType Enumeration
HelpTocDisplayType.DefaultWindow Value
HelpTocDisplayType.ExecuteMacro Value
HelpTocDisplayType.HeadingOnly Value
HelpTocDisplayType.Hide Value
HelpTocDisplayType.Popup Value
Hyperlink Class
Hyperlink() Constructor
Hyperlink.HelpLinkIncludeButton Property
Hyperlink.HelpLinkRemoveUnderline Property
Hyperlink.HelpLinkType Property
Hyperlink.HelpLinkWindow Property
Hyperlink.IncludeInHelp Property
Hyperlink.IncludeInPrint Property
Hyperlink.IncludeInWeb Property
Hyperlink.ObjectType Property
Hyperlink.PrintCrossReferenceBrackets Property
Hyperlink.PrintCrossReferenceIncludeHeading Property
Hyperlink.PrintCrossReferenceIncludePageNumber Property
Hyperlink.PrintCrossReferenceIncludePageNumberText Property
Hyperlink.PrintCrossReferenceText Property
Hyperlink.PrintFootnoteCustom Property
Hyperlink.PrintFootnoteNumberFormat Property
Hyperlink.PrintFootnoteNumberType Property
Hyperlink.PrintLinkType Property
Hyperlink.TopicTargets Property
Hyperlink.WebHelpPopupFontName Property
Hyperlink.WebHelpPopupFontSize Property
Hyperlink.WebHelpPopupMarginsHorizontal Property
Hyperlink.WebHelpPopupMarginsVertical Property
Hyperlink.WebLinkType Property
Hyperlink.WebPopupDHTMLStyleId Property
Hyperlink.WebPopupHeight Property
Hyperlink.WebPopupPositionLeft Property
Hyperlink.WebPopupPositionTop Property
Hyperlink.WebPopupWidth Property
Hyperlink.WebTargets Property
Hyperlink.WebWindowName Property
Hyperlink.WebWindowResizable Property
Hyperlink.WebWindowShowToolbar Property
Hyperlink.WebWindowStatusVisible Property
Hyperlink.WebWindowUseJavaScript Property
HyperlinkWebTarget Class
HyperlinkWebTarget() Constructor
HyperlinkWebTarget.Description Property
HyperlinkWebTarget.Url Property
LibraryInformation Class
LibraryInformation() Constructor
LibraryInformation.Comments Property
LibraryInformation.Company Property
LibraryInformation.Language Property
LibraryInformation.Name Property
LibraryInformation.Owner Property
LibraryInformation.Path Property
LibraryInformation.Subject Property
LibraryInformation.Title Property
LibraryOptions Class
LibraryOptions() Constructor
LibraryOptions.FileObjectThumbnailFolderIds Property
ListType Enumeration
ListType.Bulleted Value
ListType.ListContinue Value
ListType.NotList Value
ListType.Numbered Value
Localization Class
Localization() Constructor
Localization.Abbreviation Property
Localization.Description Property
Localization.Guid Property
Localization.LocalizationId Property
Localization.TargetLibraryId Property
Localization.TargetLibraryName Property
LoginResponse Class
LoginResponse() Constructor
LoginResponse.Result Property
LoginResponse.Token Property
LoginResult Enumeration
LoginResult.FailureDatabaseNotFound Value
LoginResult.FailureError Value
LoginResult.FailureIncorrectUsernameOrPassword Value
LoginResult.FailureLibraryFutureVersion Value
LoginResult.FailureLibraryOpen Value
LoginResult.FailureLibraryUpgradeNeeded Value
LoginResult.FailureLicensing Value
LoginResult.Success Value
ObjectBrief Class
ObjectBrief() Constructor
ObjectBrief.BasedOnDescription Property
ObjectBrief.BasedOnId Property
ObjectBrief.Description Property
ObjectBrief.FolderId Property
ObjectBrief.Guid Property
ObjectBrief.IsTemplate Property
ObjectBrief.ModifiedBy Property
ObjectBrief.ModifiedDate Property
ObjectBrief.ObjectCode Property
ObjectBrief.ObjectId Property
ObjectBrief.ObjectType Property
ObjectBrief.ReleaseStateId Property
ObjectBrief.VariantParentId Property
ObjectBrief.Version Property
ObjectCreatePermission Enumeration
ObjectCreatePermission.All Value
ObjectCreatePermission.BookCreate Value
ObjectCreatePermission.BookCreateTemplate Value
ObjectCreatePermission.FileCreate Value
ObjectCreatePermission.FileCreateTemplate Value
ObjectCreatePermission.GlossaryCreate Value
ObjectCreatePermission.GlossaryCreateTemplate Value
ObjectCreatePermission.HyperlinkCreate Value
ObjectCreatePermission.HyperlinkCreateTemplate Value
ObjectCreatePermission.IndexCreate Value
ObjectCreatePermission.IndexCreateTemplate Value
ObjectCreatePermission.IndexEntryCreate Value
ObjectCreatePermission.IndexEntryCreateTemplate Value
ObjectCreatePermission.MacroCreate Value
ObjectCreatePermission.MacroCreateTemplate Value
ObjectCreatePermission.MediaCreate Value
ObjectCreatePermission.MediaCreateTemplate Value
ObjectCreatePermission.None Value
ObjectCreatePermission.PublishProfileCreate Value
ObjectCreatePermission.PublishProfileCreateTemplate Value
ObjectCreatePermission.StyleCreate Value
ObjectCreatePermission.StyleCreateTemplate Value
ObjectCreatePermission.TOCCreate Value
ObjectCreatePermission.TOCCreateTemplate Value
ObjectCreatePermission.TOFCreate Value
ObjectCreatePermission.TOFCreateTemplate Value
ObjectCreatePermission.TopicCreate Value
ObjectCreatePermission.TopicCreateTemplate Value
ObjectCreatePermission.TPageCreate Value
ObjectCreatePermission.TPageCreateTemplate Value
ObjectHistoryItem Class
ObjectHistoryItem.ModifiedBy Property
ObjectHistoryItem.ModifiedDate Property
ObjectHistoryItem.ModifiedId Property
ObjectHistoryItem.ModifiedType Property
ObjectHistoryItem() Constructor
ObjectHistoryItem.ObjectId Property
ObjectHistoryItem.XmlStatus Property
ObjectHistoryModifiedType Enumeration
ObjectHistoryModifiedType.LibraryImport Value
ObjectHistoryModifiedType.LocalizationUpdate Value
ObjectHistoryModifiedType.Revert Value
ObjectHistoryModifiedType.TranslationJob Value
ObjectHistoryModifiedType.User Value
ObjectHistoryModifiedType.XMLImport Value
ObjectHistoryXmlStatus Enumeration
ObjectHistoryXmlStatus.Archived Value
ObjectHistoryXmlStatus.InDatabase Value
ObjectHistoryXmlStatus.None Value
ObjectListSort Enumeration
ObjectListSort.BasedOn Value
ObjectListSort.CreatedDate Value
ObjectListSort.Description Value
ObjectListSort.ModifiedByDate Value
ObjectListSort.ModifiedByUsername Value
ObjectListSort.ObjectCode Value
ObjectListSort.ObjectId Value
ObjectListSort.ObjectType Value
ObjectListSort.ReleaseState Value
ObjectListSort.StructureValidity Value
ObjectListSort.Version Value
ObjectLockInformation Class
ObjectLockInformation() Constructor
ObjectLockInformation.IsCurrentSession Property
ObjectLockInformation.ObjectId Property
ObjectLockInformation.UserName Property
ObjectRelationship Enumeration
ObjectRelationship.UsedBy Value
ObjectRelationship.Uses Value
ObjectSearchCriteria Class
ObjectSearchCriteria() Constructor
ObjectSearchCriteria.Field Property
ObjectSearchCriteria.Value Property
ObjectSearchField Enumeration
ObjectSearchField.BasedOnDescription Value
ObjectSearchField.BasedOnId Value
ObjectSearchField.ContainingText Value
ObjectSearchField.Description Value
ObjectSearchField.FolderId Value
ObjectSearchField.InBookId Value
ObjectSearchField.IsTemplate Value
ObjectSearchField.ModifiedFromDate Value
ObjectSearchField.ModifiedToDate Value
ObjectSearchField.ObjectCode Value
ObjectSearchField.ObjectType Value
ObjectSearchField.ReleaseStateId Value
ObjectSearchField.ResolveSubBooks Value
ObjectSearchField.VariableAssignment Value
ObjectStatus Enumeration
ObjectStatus.Active Value
ObjectStatus.Inactive Value
ObjectStatus.Redundant Value
ObjectType Enumeration
ObjectType.Book Value
ObjectType.File Value
ObjectType.Glossary Value
ObjectType.Hyperlink Value
ObjectType.Index Value
ObjectType.IndexEntry Value
ObjectType.Macro Value
ObjectType.Media Value
ObjectType.PublishProfile Value
ObjectType.Style Value
ObjectType.TableOfContents Value
ObjectType.TableOfFigures Value
ObjectType.TitlePage Value
ObjectType.Topic Value
OutputType Enumeration
OutputType.Help Value
OutputType.Print Value
OutputType.Web Value
Permission Enumeration
Permission.All
Permission.ChangePermission
Permission.ChangeReleaseState
Permission.ChangeVersion
Permission.Delete
Permission.List
Permission.ModifyFolders
Permission.None
Permission.Publish
Permission.Read
Permission.Write
PrintBreakType Enumeration
PrintBreakType.Column Value
PrintBreakType.None Value
PrintBreakType.Page Value
PrintBreakType.Section Value
PrintCrossReferenceIncludeHeading Enumeration
PrintCrossReferenceIncludeHeading.Always Value
PrintCrossReferenceIncludeHeading.Never Value
PrintCrossReferenceIncludeHeading.WhenDifferent Value
PrintFootnoteNumberFormat Enumeration
PrintFootnoteNumberFormat.AlphabeticalLowerCase Value
PrintFootnoteNumberFormat.AlphabeticalUpperCase Value
PrintFootnoteNumberFormat.Digits Value
PrintFootnoteNumberFormat.RomanLowerCase Value
PrintFootnoteNumberFormat.RomanUpperCase Value
PrintFootnoteNumberType Enumeration
PrintFootnoteNumberType.Automatic Value
PrintFootnoteNumberType.Custom Value
PrintLinkType Enumeration
PrintLinkType.CrossReference Value
PrintLinkType.EmbeddedBlock Value
PrintLinkType.EmbeddedInline Value
PrintLinkType.FootNote Value
PublishingJob Class
PublishingJob.BookDescription Property
PublishingJob.BookId Property
PublishingJob.ComputerName Property
PublishingJob.EndTime Property
PublishingJob.Format Property
PublishingJob.JobId Property
PublishingJob.Message Property
PublishingJob.Path Property
PublishingJob.Priority Property
PublishingJob.ProfileDescription Property
PublishingJob.ProfileId Property
PublishingJob() Constructor
PublishingJob.StartTime Property
PublishingJob.Status Property
PublishingJob.SubmittedTime Property
PublishingJob.Url Property
PublishingJob.UserId Property
PublishJobUserSearchOption Enumeration
PublishJobUserSearchOption.AllJobs
PublishJobUserSearchOption.MyJobs
PublishPriority Enumeration
PublishPriority.High
PublishPriority.Low
PublishPriority.Medium
PublishStatus Enumeration
PublishStatus.Cancelled Value
PublishStatus.Completed Value
PublishStatus.Pending Value
PublishStatus.Queued Value
PublishStatus.Started Value
PublishType Enumeration
PublishType.Aspect Value
PublishType.DITA Value
PublishType.HTML Value
PublishType.HTMLHelp Value
PublishType.JavaHelp Value
PublishType.OracleHelp Value
PublishType.PDF Value
PublishType.Website Value
PublishType.WinHelp Value
PublishType.Word Value
PublishType.XHTML Value
PublishType.XML Value
ReleaseState Class
ReleaseState.BackgroundColor Property
ReleaseState.ForegroundColor Property
ReleaseState.Guid Property
ReleaseState.Name Property
ReleaseState.ReleaseState Constructor
ReleaseState.ReleaseStateId Property
RoleProfile Class
RoleProfile.IsAuthor Property
RoleProfile.IsLocalizer Property
RoleProfile.IsReviewer Property
RoleProfile.IsSupervisor Property
SortDirection Enumeration
SortDirection.Ascending
SortDirection.Descending
Structure Class
Structure.Description Property
Structure.EnforcedReleaseStates Property
Structure.ExampleObjectId Property
Structure.Name Property
Structure.ObjectId Property
Structure.Rules Property
Structure.Structure Constructor
Structure.StructureId Property
StructureRule Class
StructureRule.AllowedIds Property
StructureRule.Children Property
StructureRule.Description Property
StructureRule.MaximumOccurrence Property
StructureRule.MinimumOccurrence Property
StructureRule.Name Property
StructureRule.ParentRuleId Property
StructureRule.RuleType Property
StructureRule.Sequence Property
StructureRule.StructureId Property
StructureRule.StructureRule Constructor
StructureRule.StructureRuleId Property
StructureRuleSequence Enumeration
StructureRuleSequence.Fixed
StructureRuleSequence.Flexible
StructureRuleType Enumeration
StructureRuleType.Book
StructureRuleType.CharacterStyle
StructureRuleType.EmbeddedTopic
StructureRuleType.File
StructureRuleType.Glossary
StructureRuleType.Group
StructureRuleType.Hyperlink
StructureRuleType.Index
StructureRuleType.Macro
StructureRuleType.ParagraphStyle
StructureRuleType.Table
StructureRuleType.TableCell
StructureRuleType.TableOfContents
StructureRuleType.TableOfFigures
StructureRuleType.TextRequired
StructureRuleType.TitlePage
StructureRuleType.Topic
StructureRuleType.Variable
StructureTableCellRule Class
StructureTableCellRule.MaximumRange Property
StructureTableCellRule.MinimumRange Property
StructureTableCellRule.StructureTableCellRule Constructor
StructureTableCellRule.TableRuleType Property
StructureTableCellRuleType Enumeration
StructureTableCellRuleType.AllColumns
StructureTableCellRuleType.AllRows
StructureTableCellRuleType.EvenColumns
StructureTableCellRuleType.EvenRows
StructureTableCellRuleType.FirstColumn
StructureTableCellRuleType.FirstRow
StructureTableCellRuleType.HeaderRow
StructureTableCellRuleType.LastColumn
StructureTableCellRuleType.LastRow
StructureTableCellRuleType.OddColumns
StructureTableCellRuleType.OddRows
StructureTableCellRuleType.RangeColumns
StructureTableCellRuleType.RangeRows
StructureValidity Enumeration
StructureValidity.Invalid
StructureValidity.NotApplicable
StructureValidity.NotValidated
StructureValidity.Valid
StyleType Enumeration
StyleType.Character
StyleType.Paragraph
Topic Class
Topic() Constructor
Topic.HelpHeading Property
Topic.HelpHeadingStyleId Property
Topic.HelpIncludeInBrowseSequence Property
Topic.HelpMacroId Property
Topic.HelpNonScrolling Property
Topic.HelpStartNewBrowseSequence Property
Topic.HelpTocDisplay Property
Topic.HelpTocMacroId Property
Topic.HelpWindowId Property
Topic.IncludeInHelp Property
Topic.IncludeInPrint Property
Topic.IncludeInWeb Property
Topic.ObjectType Property
Topic.PrintBreak Property
Topic.PrintHeading Property
Topic.PrintHeadingAutoNumberStyle Property
Topic.PrintHeadingStyleId Property
Topic.PrintMediaId Property
Topic.PrintSuperHeading Property
Topic.WebFilename Property
Topic.WebHeading Property
Topic.WebMediaId Property
Topic.WebStartNewPage Property
Topic.WebTitle Property
TranslationJob Class
TranslationJob.Description Property
TranslationJob.GroupId Property
TranslationJob.Guid Property
TranslationJob.JobReference Property
TranslationJob.LocalizatonId Property
TranslationJob.SourceLocalizationId Property
TranslationJob.Status Property
TranslationJob.TargetLocalizationId Property
TranslationJob.TranslationJob Constructor
TranslationJob.TranslationJobId Property
TranslationJobStatus Enumeration
TranslationJobStatus.ExportedForTranslation
TranslationJobStatus.ImportedFromTranslation
TranslationJobStatus.New
TranslationJobStatus.ReadyForImport
TranslationJobStatus.ReadyForTranslation
UserAccount Class
UserAccount() Constructor
UserAccount.ActiveDirectoryUser Property
UserAccount.Email Property
UserAccount.IsAuthorInherited Property
UserAccount.IsLocalizerInherited Property
UserAccount.IsReviewerInherited Property
UserAccount.IsSupervisorInherited Property
UserAccount.Name Property
UserAccount.UserId Property
Variable Class
Variable.Description Property
Variable.IsPublishPrompt Property
Variable.IsVariantCriteria Property
Variable.ListOfValues Property
Variable.ListOfValuesRelationships Property
Variable.Name Property
Variable.StyleId Property
Variable.Value Property
Variable.ValueObjectId Property
Variable.Variable Constructor
Variable.VariableId Property
Variable.VariableType Property
VariableAssignment Class
VariableAssignment.ObjectId Property
VariableAssignment.Value Property
VariableAssignment.ValueObjectId Property
VariableAssignment.VariableAssignment Constructor
VariableAssignment.VariableId Property
VariableType Enumeration
VariableType.FileObject Value
VariableType.ListOfValues Value
VariableType.System Value
VariableType.Text Value
WebLinkType Enumeration
WebLinkType.Default Value
WebLinkType.ExpandBlock Value
WebLinkType.ExpandInline Value
WebLinkType.NewWindow Value
WebLinkType.PopupClick Value
WebLinkType.PopupHover Value
WebLinkType.PopupNative Value
XtendSuggestedTopic Class
XtendSuggestedTopic.Description Property
XtendSuggestedTopic.Html Property
XtendSuggestedTopic.ID Property
XtendSuggestedTopic.XtendSuggestedTopic Constructor
XtendSuggestion Class
XtendSuggestion.FragmentId Property
XtendSuggestion.LocalizationIds Property
XtendSuggestion.PercentageMatch Property
XtendSuggestion.ReleaseStateIds Property
XtendSuggestion.ReuseCount Property
XtendSuggestion.Text Property
XtendSuggestion.UsedInTopicIds Property
XtendSuggestion.XtendSuggestion Constructor
Authorit.API.Exceptions Namespace
APIExceptionBase Class
AuthenticationException Class
AuthenticationException.AuthenticationException Constructor
AuthenticationException.FaultDetail Property
AuthenticationFaultDetail Class
AuthenticationFaultDetail.AuthenticationFaultDetail Constructor
ConfigurationException Class
ConfigurationException.ConfigurationException Constructor
ConfigurationException.ConfigurationException Constructor (string)
IdentifierException Class
IdentifierException.FaultDetail Property
IdentifierException.Identifier Property
IdentifierException.IdentifierException Constructor (object)
IdentifierException.Message Property
IdentifierFaultDetail Class
IdentifierFaultDetail.Identifier Property
IdentifierFaultDetail.IdentifierFaultDetail Constructor
IdentifierFaultDetail.IdentifierFaultDetail Constructor (object)
LicenseRoleMismatchDetail Class
LicenseRoleMismatchDetail.LicenseRoleMismatchDetail Constructor
LicenseRoleMismatchDetail.LicenseRoleMismatchDetail Constructor (System.Collections.Generic.Dictionary<Authorit.API.Dto.Reviewer.ReviewParticipantType,System.Collections.Generic.List<int>>)
LicenseRoleMismatchException Class
LicenseRoleMismatchException.FaultDetail Property
LicenseRoleMismatchException.LicenseRoleMismatchException Constructor
LicenseRoleMismatchException.LicenseRoleMismatchException Constructor (System.Collections.Generic.Dictionary<Authorit.API.Dto.Reviewer.ReviewParticipantType,System.Collections.Generic.List<int>>)
LicenseRoleMismatchException.Message Property
LicenseRoleMismatchException.UserIdsByType Property
LicensesExhaustedDetail Class
LicensesExhaustedDetail.LicensesExhaustedDetail Constructor
LicensesExhaustedException Class
LicensesExhaustedException.FaultDetail Property
LicensesExhaustedException.LicensesExhaustedException Constructor
LicensesExhaustedException.Message Property
LockException Class
LockException.FaultDetail Property
LockException.LockException Constructor
LockException.LockException Constructor (int, string)
LockException.Message Property
LockException.ObjectId Property
LockException.Username Property
LockFaultDetail Class
LockFaultDetail.LockFaultDetail Constructor
LockFaultDetail.LockFaultDetail Constructor (int, string)
LockFaultDetail.ObjectId Property
LockFaultDetail.Username Property
ObjectCreatePermissionsException Class
ObjectCreatePermissionsException.FaultDetail Property
ObjectCreatePermissionsException.FolderId Property
ObjectCreatePermissionsException.Message Property
ObjectCreatePermissionsException.ObjectCreatePermissionsException Constructor (int, Authorit.API.Dto.ObjectCreatePermission)
ObjectCreatePermissionsException.RequiredPermissions Property
ObjectCreatePermissionsFaultDetail Class
ObjectCreatePermissionsFaultDetail.FolderId Property
ObjectCreatePermissionsFaultDetail.ObjectCreatePermissionsFaultDetail Constructor
ObjectCreatePermissionsFaultDetail.ObjectCreatePermissionsFaultDetail Constructor (int, Authorit.API.Dto.ObjectCreatePermission)
ObjectCreatePermissionsFaultDetail.RequiredPermissions Property
OperationException Class
OperationException.FaultDetail Property
OperationException.Message Property
OperationException.OperationException Constructor
OperationException.OperationException Constructor (string)
OperationFaultDetail Class
OperationFaultDetail.OperationFaultDetail Constructor
PermissionsException Class
PermissionsException.FaultDetail Property
PermissionsException.FolderId Property
PermissionsException.Message Property
PermissionsException.PermissionsException Constructor
PermissionsException.PermissionsException Constructor (int, Authorit.API.Dto.Permission)
PermissionsException.PermissionsException Constructor (int, int, Authorit.API.Dto.Permission)
PermissionsException.ReleaseStateId Property
PermissionsException.RequiredPermissions Property
PermissionsFaultDetail Class
PermissionsFaultDetail.FolderId Property
PermissionsFaultDetail.PermissionsFaultDetail Constructor
PermissionsFaultDetail.PermissionsFaultDetail Constructor (int, Authorit.API.Dto.Permission)
PermissionsFaultDetail.PermissionsFaultDetail Constructor (int, int, Authorit.API.Dto.Permission)
PermissionsFaultDetail.ReleaseStateId Property
PermissionsFaultDetail.RequiredPermissions Property
ReadOnlyException Class
ReadOnlyException.FaultDetail Property
ReadOnlyException.Message Property
ReadOnlyException.ReadOnlyException Constructor
ReadOnlyFaultDetail Class
ReadOnlyFaultDetail.ReadOnlyFaultDetail Constructor
UnexpectedException Class
UnexpectedException.FaultDetail Property
UnexpectedException.Message Property
UnexpectedException.OriginalMessage Property
UnexpectedException.OriginalSource Property
UnexpectedException.OriginalStackTrace Property
UnexpectedException.UnexpectedException Constructor
UnexpectedException.UnexpectedException Constructor (System.Exception)
UnexpectedFaultDetail Class
UnexpectedFaultDetail.OriginalMessage Property
UnexpectedFaultDetail.OriginalSource Property
UnexpectedFaultDetail.OriginalStackTrace Property
UnexpectedFaultDetail.UnexpectedFaultDetail Constructor
UnexpectedFaultDetail.UnexpectedFaultDetail Constructor (System.Exception)
ValidationException Class
ValidationException.FaultDetail Property
ValidationException.FieldName Property
ValidationException.ValidationException Constructor
ValidationException.ValidationException Constructor (string)
ValidationException.ValidationException Constructor (string, string)
ValidationException.ValidationException Constructor (string, string, string)
ValidationException.Value Property
ValidationFaultDetail Class
ValidationFaultDetail.FieldName Property
ValidationFaultDetail.ValidationFaultDetail Constructor
ValidationFaultDetail.ValidationFaultDetail Constructor (string, string)
ValidationFaultDetail.Value Property
Authorit.API.Security Namespace
AuthenticationType Enumeration
AuthenticationType.Basic Value
AuthenticationType.IntegratedActiveDirectory Value
AuthenticationType.RemoteActiveDirectory Value
UserCredentials Class
UserCredentials() Constructor
UserCredentials(string) Constructor
UserCredentials(string, string) Constructor
UserCredentials(string, string, string, Authorit.API.Security.AuthenticationType) Constructor
UserCredentials(string, string, string, string, Authorit.API.Security.AuthenticationType) Constructor
UserCredentials.AuthenticationType Property
UserCredentials.Domain Property
UserCredentials.Equals(object) Method
UserCredentials.GetAuthToken(string) Method
UserCredentials.GetSchema() Method
UserCredentials.LibraryAlias Property
UserCredentials.Password Property
UserCredentials.ReadXml(System.Xml.XmlReader) Method
UserCredentials.ToString() Method
UserCredentials.UserCredentials(string, string, string) Constructor
UserCredentials.Username Property
UserCredentials.WriteXml(System.Xml.XmlWriter) Method
Authorit.API.Services Namespace
Authentication Class
Authentication.Authentication() Constructor
Authentication.IsLoggedIn() Method
Authentication.Login(string, string, string) Method
Authentication.LoginEx(string, string, string, Authorit.API.Dto.AuthorITModule) Method
Authentication.LoginWithActiveDirectory(string) Method
Authentication.LoginWithActiveDirectoryEx(string, Authorit.API.Dto.AuthorITModule) Method
Authentication.LoginWithRemoteActiveDirectory(string, string, string) Method
Authentication.LoginWithRemoteActiveDirectoryEx(string, string, string, Authorit.API.Dto.AuthorITModule) Method
Authentication.Logout() Method
Book Class
Book() Constructor
Book.Create(Authorit.API.Dto.Book) Method
Book.Get(int) Method
Book.Update(Authorit.API.Dto.Book) Method
File Class
File() Constructor
File.Create(Authorit.API.Dto.File) Method
File.Get(int) Method
File.GetConvertedContent(int, Authorit.API.Dto.OutputType) Method
File.GetConvertedContentResized(int, Authorit.API.Dto.OutputType, int, int) Method
File.GetSourceContent(int, Authorit.API.Dto.OutputType) Method
File.GetSourceContentResized(int, Authorit.API.Dto.OutputType, int, int) Method
File.SetSourceContent(int, byte[], string) Method
File.Update(Authorit.API.Dto.File) Method
Folder Class
Folder.CheckSubfolderExists Function (int, string)
Folder.Create Function (int, string)
Folder.Delete Function (int)
Folder.EnsureExists Function (int, string)
Folder.Folder Constructor
Folder.Get Function (int)
Folder.GetByGuid Function (System.Guid)
Folder.GetByName Function (string)
Folder.GetByParentAndName Function (int, string)
Folder.GetChildren Function (int)
Folder.GetGuidForId Function (int)
Folder.GetIdForGuid Function (System.Guid)
Folder.GetPathToFolder Function (int)
Folder.IsValidFolderId Function (int, bool)
Folder.Move Function (int, int)
Folder.Rename Function (int, string)
Hyperlink Class
Hyperlink.Create Function (Authorit.API.Dto.Hyperlink)
Hyperlink.Get Function (int)
Hyperlink.Hyperlink Constructor
Hyperlink.Update Function (Authorit.API.Dto.Hyperlink)
Library Class
Library() Constructor
Library.GetInformation() Method
Library.GetOptions() Method
Licensing Class
Licensing.GetReviewerLicenses() Method
Licensing.IsLicensedForLive() Method
Licensing.IsLicensedForReviewer() Method
Localization Class
Localization.CancelTranslationJob Function (int)
Localization.ExportTranslationJob Function (int)
Localization.Get Function (int)
Localization.GetAll Function
Localization.GetAllTranslationJobs Function
Localization.GetTranslationJob Function (int)
Localization.Localization Constructor
ObjectCommon Class
ObjectCommon.ApplyTemplate(int, int) Method
ObjectCommon.ChangeReleaseState(int, int) Method
ObjectCommon.ChangeReleaseStateMultiple(System.Collections.Generic.IList<int>, int) Method
ObjectCommon.CheckExists(int) Method
ObjectCommon.CheckExistsByGuid(System.Guid) Method Summary
ObjectCommon.CheckExistsWithObjectType(int, Authorit.API.Dto.ObjectType) Method
ObjectCommon.Create(Authorit.API.Dto.ObjectType, string, int, int) Method
ObjectCommon.CreateVersion(int) Method
ObjectCommon.Delete(int) Method
ObjectCommon.DeleteMultiple(System.Collections.Generic.IList<int>) Method
ObjectCommon.Duplicate(int) Method
ObjectCommon.GetGuidForId(int) Method
ObjectCommon.GetHistory(int, bool) Method
ObjectCommon.GetIdForGuid(System.Guid) Method
ObjectCommon.GetLockInformation(int) Method
ObjectCommon.GetObjectBrief(int) Method
ObjectCommon.GetObjectBriefByGuid(System.Guid) Method
ObjectCommon.GetObjectBriefs(System.Collections.Generic.IList<int>) Method
ObjectCommon.GetObjectsInFolder(int, Authorit.API.Dto.ObjectListSort, Authorit.API.Dto.SortDirection) Method
ObjectCommon.GetRelated(int, Authorit.API.Dto.ObjectRelationship) Method
ObjectCommon.GetTemplates(Authorit.API.Dto.ObjectType, bool) Method
ObjectCommon.GetTemplatesForObject(int) Method
ObjectCommon.GetXml(int) Method
ObjectCommon.GetXmlAsDocument(int) Method
ObjectCommon.GetXmlFromHistory(int, int) Method
ObjectCommon.IsVariantParent(int) Method
ObjectCommon.Lock(int) Method
ObjectCommon.LockMultiple(System.Collections.Generic.IList<int>) Method
ObjectCommon.Move Function (int, int)
ObjectCommon.MoveMultiple Function (System.Collections.Generic.IList<int>, int)
ObjectCommon() Constructor
ObjectCommon.RenewLocks() Method
ObjectCommon.Replace(int, int) Method
ObjectCommon.SaveXml Function (string, bool, bool)
ObjectCommon.Search Function (System.Collections.Generic.IList<Authorit.API.Dto.ObjectSearchCriteria>, Authorit.API.Dto.ObjectListSort, Authorit.API.Dto.SortDirection)
ObjectCommon.SetActiveVersion Function (int)
ObjectCommon.Unlock Function (int)
ObjectCommon.UnlockMultiple Function (System.Collections.Generic.IList<int>)
ObjectCommon.UpdateObjectBrief Function (Authorit.API.Dto.ObjectBrief)
Permissions Class
Permissions.CheckObjectCreatePermissions Function (int, Authorit.API.Dto.ObjectCreatePermission)
Permissions.CheckPermissionsForFolder Function (int, Authorit.API.Dto.Permission)
Permissions.CheckPermissionsForFolderAndReleaseState Function (int, int, Authorit.API.Dto.Permission)
Permissions.CheckPermissionsForObject Function (int, Authorit.API.Dto.Permission)
Permissions.GetObjectCreatePermissions Function (int)
Permissions.GetPermissionsForFolder Function (int)
Permissions.GetPermissionsForFolderAndReleaseState Function (int, int)
Permissions.GetPermissionsForObject Function (int)
Permissions.GetPermissionsForReleaseState Function (int)
Permissions.Permissions Constructor
Permissions.TestObjectCreatePermissions Function (Authorit.API.Dto.ObjectCreatePermission, Authorit.API.Dto.ObjectCreatePermission)
Permissions.TestPermissions Function (Authorit.API.Dto.Permission, Authorit.API.Dto.Permission)
Publishing Class
Publishing.CancelJob Function (int)
Publishing.CheckPublishingServerConfigured Function
Publishing.CreatePublishingServerJob Function (int, int, Authorit.API.Dto.PublishPriority, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>)
Publishing.GetJob Function (int)
Publishing.GetProfilesForBook Function (int)
Publishing.GetPublishingServerPath Function
Publishing.GetPublishingServerUrl Function
Publishing.IsVariableAssignmentRequired Function (int, System.Collections.Generic.IList<int>)
Publishing.Publishing Constructor
Publishing.SearchJobs Function (System.DateTime, System.DateTime, Authorit.API.Dto.PublishJobUserSearchOption, int, int)
ReleaseState Class
ReleaseState.Get(int) Method
ReleaseState.GetAll() Method
ReleaseState.GetByGuid(Guid) Method
ReleaseState.GetGuidForId(int) Method
ReleaseState.GetIdForGuid(Guid) Method
ReleaseState.IsValidReleaseStateId(int) Method
ReleaseState() Constructor
ServiceBase Class
ServiceBase.GetServiceInstance Function
ServiceBase.IsReadOnlyMode Property
StructuredAuthoring Class
StructuredAuthoring.GetEnforcedReleaseStatesForObject Function (int)
StructuredAuthoring.GetEnforcedReleaseStatesForStructure Function (int)
StructuredAuthoring.GetStructure Function (int)
StructuredAuthoring.StructuredAuthoring Constructor
StructuredAuthoring.TestValidateObject Function (int, int)
StructuredAuthoring.ValidateBookContents Function (int, System.Collections.Generic.IList<Authorit.API.Dto.BookTocEntry>)
StructuredAuthoring.ValidateTopicText Function (int, string)
Style Class
Style.GetDefaultCharacterStyle Function
Style.GetDefaultParagraphStyle Function
Style.GetStyleSheet Function
Style.Style Constructor
Topic Class
Topic.Create Function (Authorit.API.Dto.Topic)
Topic.Get Function (int)
Topic.GetResolvedTopicTextXml(int, int) Method
Topic.GetTopicTextXml Function (int)
Topic.GetTopicXhtml Function (int)
Topic.SaveTopicTextFromXml Function (int, string)
Topic.Topic Constructor
Topic.Update Function (Authorit.API.Dto.Topic)
UserAccount Class
UserAccount.ChangePassword(int, string) Method
UserAccount.CreateGroup(Authorit.API.Dto.Group) Method
UserAccount.CreateUser(Authorit.API.Dto.UserAccount) Method
UserAccount.DeleteGroup(int) Method
UserAccount.DeleteUser Function (int)
UserAccount.GetGroup Function (int)
UserAccount.GetGroupByName Function (string)
UserAccount.GetGroupMembers Function (int)
UserAccount.GetGroups Function
UserAccount.GetLastLogin Function (int)
UserAccount.GetRecentLogonFailures Function (int)
UserAccount.GetUser Function (int)
UserAccount.GetUserByName Function (string)
UserAccount.GetUsers Function
UserAccount.GetUsersGroups(int) Method
UserAccount.ResetLogonFailures Function (int)
UserAccount.SetUsersGroups Function (int, System.Collections.Generic.IList<int>)
UserAccount.UpdateGroup Function (Authorit.API.Dto.Group)
UserAccount.UpdateUser Function (Authorit.API.Dto.UserAccount)
UserAccount() Constructor
Variable Class
Variable() Constructor
Variable.Assign(Authorit.API.Dto.VariableAssignment) Method
Variable.AssignMultiple(System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.CheckAssignmentExists(Authorit.API.Dto.VariableAssignment) Method
Variable.CheckVariantExists(int, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.CreateVariant(int, System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Variable.Get(int) Method
Variable.GetAll() Method
Variable.GetAssignment(int, int) Method
Variable.GetAssignmentByName(int, string) Method
Variable.GetAssignments(int) Method
Variable.GetByName(string) Method
Variable.GetVariantCriteria(int) Method
Variable.GetVariantCriteriaToAssignForPublishing(int, int) Method
Variable.RemoveVariantAssociation(int) Method
Variable.SearchByName(string, bool) Method
Variable.SetAssignments(System.Collections.Generic.IList<Authorit.API.Dto.VariableAssignment>) Method
Xtend Class
Xtend.GetParagraphHighlightColor Function (string)
Xtend.GetParagraphHighlightColorInTopic Function (string, int)
Xtend.GetSuggestionHtml Function (int, int, bool)
Xtend.GetSuggestions Function (string)
Xtend.GetSuggestionsInTopic Function (string, int)
Xtend.GetTopicDetails Function (int, bool)
Xtend.GetTopicsDetails Function (int[], bool)
Xtend.Xtend Constructor
DeactivateUIControlArgs Class

Gets or sets the the Windows Help Macros for the topic.

Type: Integer

Value

The object ID for the Macro Procedure object.

Back to home page