Getting Started

From BKeeney Shorts Documentation
Jump to: navigation, search

Installing the Core Classes

Installing the core classes for BKeeney Shorts is easy to do!

  1. Copy the BKeeney_Shorts folder from the distribution project into your project.
  2. Start using!

You are now ready to use BKeeney Shorts!

Note: If you do not have (or do not intend to use) the DynaPDF plugin from MonkeyBread Software, you should remove the BKS_ShortsDynaPDF module.
You will experience a number of compiler errors if you leave BKS_ShortsDynaPDF in without the plugin installed.

Working with the Code

Demo Application

Sample of the class hierarchy

We have provided a demo application to show how to access the BKeeney Shorts functionality in a working application. Sometimes when working with complex software like the BKeeney Shorts, there is no substitute for a working example to show you how to do something. To run the demo you will need MonkeyBread Software's DynaPDF plugin

Class Hierarchy

Pictured right is the basic class hierarchy for BKeeney Shorts (not all classes implemented in the BKeeney Shorts are shown).
BKeeney Shorts resides in its own namespace. This allows you to run BKeeney Shorts and its classes without colliding with any other classes with similar names.

Creating Subclasses

You should NOT modify the original source code, but instead create subclasses and make your changes to your subclasses. This will isolate your code changes from the base class changes in future releases of the BKeeney Shorts. If the BKeeney Shorts does not fulfill all of your requirements, you have a couple of options. The first is to use the provided events in the instance of the BKeeney Shorts to fill out the desired functionality. The second is to create subclasses of certain classes within the BKeeney Shorts.