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 [2010/09/10 20:17]
Stonepaw Added what I have noted down so far. Alphabetized the lists
developer:api [2016/08/09 16:14] (current)
172.98.67.27 [book] Added read only ReadPercentage
Line 26: Line 26:
 This can be useful e.g. to search for similar versions, years or series titles when doing things with the selected books. ​ This can be useful e.g. to search for similar versions, years or series titles when doing things with the selected books. ​
  
-  ComicRack.App.AddNewBook(showDialog)+  ComicRack.App.AddNewBook(bool showDialog)
   ​   ​
-Command to add new [[developer:​api#​book|books]] to the library.+Command to add new fileless ​[[developer:​api#​book|books]] to the library. If showDialog is True the info dialog is show. Returns the new fileless book.
  
   ComicRack.App.RemoveBook(book)   ComicRack.App.RemoveBook(book)
Line 41: Line 41:
  
 Returns a bitmap with the full page image of the specified [[developer:​api#​book|book]] and page (pages start with 0).  ​ Returns a bitmap with the full page image of the specified [[developer:​api#​book|book]] and page (pages start with 0).  ​
 +
 +  ComicRack.App.GetComicThumbnail(book,​ page)
 +  ​
 +Returns a bitmap of the Comic thumbnail. Book is a [[developer:​api#​book|book]] object and page is a integer.
  
  
Line 59: Line 63:
 String String
   book.Characters   book.Characters
-String+String ​- The characters field. The string is formated with commas separating different characters.
   book.Colorist   book.Colorist
 String String
Line 123: Line 127:
   book.BookmarkCountAsText   book.BookmarkCountAsText
 String - The number of bookmarks as a string. String - The number of bookmarks as a string.
 +  book.Caption
 +String - The caption of the book.
 +  book.CaptionWithoutFormat
 +String - The caption of the book.
 +  book.CaptionWithoutTitle
 +String - The caption of the book without the title.
 +  book.ShadowNumber
 +String - Proposed Number
   book.ShadowSeries   book.ShadowSeries
 String - Proposed series. String - Proposed series.
   book.ShadowVolume   book.ShadowVolume
-String ​- Proposed volume.+Integer ​- Proposed volume.
   book.ShadowYear   book.ShadowYear
 Number - Proposed year. Number - Proposed year.
 +  book.ReadPercentage
 +Integer - Percentage of the book that has been read.
  
  
Line 134: Line 148:
   book.AddedTime   book.AddedTime
 System.DateTime - The time the book was added to the library. Can be modified. System.DateTime - The time the book was added to the library. Can be modified.
 +  book.ReleasedTime
 +System.DateTime - The time was in the store. Can be modified.
   book.BlackAndWhite   book.BlackAndWhite
 cYo.Projects.ComicRack.Engine.YesNo - The black and white field. Valid are YesNo.Yes, YesNo.No and YesNo.Unknown cYo.Projects.ComicRack.Engine.YesNo - The black and white field. Valid are YesNo.Yes, YesNo.No and YesNo.Unknown
 +  book.ColorAdjustment
 +cYo.Common.Drawing.BitmapAdjustment - Used to adjust the color.
   book.FilePath   book.FilePath
 The file path for a book. If it is NULL, then the book is '​fileless'​. The file path for a book. If it is NULL, then the book is '​fileless'​.
 +  boook.PageCount
 +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
  
-=== Methods === 
  
 +
 +=== 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 ===
 +  book.ClearBookmarks()
 +Deletes all the bookmarks in the book.
 +  book.SetCustomValue(key,​value)
 +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)
 +Deletes a custom value from the book
 +  book.GetCustomValue(key)
 +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()
 +Returns a copy of the current book. Does not add it to the library.

Navigation