This is an old revision of the document!


Scripts API Reference

ComicRack.App

Properties

ComicRack.MainWindow

The handle to the main window of ComicRack. Useful when needing a parent window for displaying dialogs.

ComicRack.App.ProductVersion

Version number of ComicRack.

Methods

ComicRack.App.AskQuestion(question, buttontext, optiontext)

A simple question dialog for the scripts

ComicRack.App.GetLibraryBooks()

Returns the collection of all books in the library.

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(bool showDialog)

Command to add new fileless books to the library. If showDialog is True the info dialog is show. Returns the new fileless book.

ComicRack.App.RemoveBook(book)

Command to remove a book from the library.

ComicRack.App.SetCustomBookThumbnail(book, bitmap)

Command to change thumbnail image for a book.

ComicRack.App.GetComicPage(book,page)

Returns a bitmap with the full page image of the specified book and page (pages start with 0).

ComicRack.App.GetComicThumbnail(book, page)

Returns a bitmap of the Comic thumbnail. Book is a book object and page is a integer.

books

Collection of book objects.

book

Properties

Textual properties
book.AgeRating

String - The age rating field

book.AlternateNumber

String

book.AlternateSeries

String

book.Characters

String - The characters field. The string is formated with commas separating different characters.

book.Colorist

String

book.CoverArtist

String

book.Editor

String

book.Genre

String

book.Imprint

String

book.Inker

String

book.Letterer

String

book.Notes

String

book.Number

String

book.Penciller

String

book.Publisher

String

book.Series

String

book.Summary

String

book.Tags

String

book.Teams

String

book.Title

String

book.Web

String

book.Writer

String

Count properties
book.AlternateCount

Number - Returns -1 when field is blank.

book.Year

Number

book.Month

Number

book.Volume

Number

book.Rating

Number

Read only properties
book.AddedTimeAsText

String - The time the book was added to the library in the format: dd/mm/yyyy hh:mm:ss AM/PM

book.AlternateCaption

String - Seems to return the alternate series or title.

book.AlternateCountAsText

String - Returns the Alternate Count as a string.

book.ArtistInfo

String - Returns the artists in the format: Writer\Penciller\Inker\Colorist\Letterer\Cover Artist

book.BlackAndWhiteAsText

String - The black and white field as a string.

book.BookmarkCount

Number - The number of bookmarks.

book.BookmarkCountAsText

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

String - Proposed series.

book.ShadowVolume

Integer - Proposed volume.

book.ShadowYear

Number - Proposed year.

Other properties
book.AddedTime

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

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

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

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