Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:api [2013/04/01 14:10]
cyo updated API a little bit
developer:api [2016/08/09 16:14] (current)
172.98.67.27 [book] Added read only ReadPercentage
Line 141: Line 141:
   book.ShadowYear   book.ShadowYear
 Number - Proposed year. Number - Proposed year.
 +  book.ReadPercentage
 +Integer - Percentage of the book that has been read.
  
  
Line 156: Line 158:
   boook.PageCount   boook.PageCount
 The number of pages in the book. The number of pages in the book.
 +  book.SeriesComplete
 +cYo.Projects.ComicRack.Engine.YesNo - The Series Complete field. Valid are YesNo.Yes, YesNo.No and YesNo.Unknown
 +
 +
 +
 +=== Pages ===
 +A collection of book.page objects
 +
 +=== Page ===
 +  book.Pages[#​]
 +The pages, by number (#) in the book
 +  book.Pages[#​].PageType
 +String value representing the type of page referenced by number. ​ Valid values includes are FrontCover, InnerCover, Roundup, Story, Advertisement,​ Editorial, Letters, Preview, BackCover, Other, Deleted
 +
  
 === Methods === === Methods ===
Line 161: Line 177:
 Deletes all the bookmarks in the book. Deletes all the bookmarks in the book.
   book.SetCustomValue(key,​value)   book.SetCustomValue(key,​value)
-Stores a custom value in the book with the unique key.+Stores a custom value in the book with the unique key. You can hide the value from the user be putting a '​.'​ into the key like '​MyScript.MyValue'​. Such values will not be displayed in the user interface (except when turned on with //​ShowCustomScriptValues = true// in ComicRack.ini
   book.DeleteCustomValue(key)   book.DeleteCustomValue(key)
 Deletes a custom value from the book Deletes a custom value from the book
   book.GetCustomValue(key)   book.GetCustomValue(key)
 Returns a previously stored custom value. Returns a previously stored custom value.
 +  book.GetCustomValues()
 +Returns a list of all custom values stored in the book. The result is a list of objects with two properties: Key and Value
   book.Clone()   book.Clone()
 Returns a copy of the current book. Does not add it to the library. Returns a copy of the current book. Does not add it to the library.

Navigation