C# Class SIL.FieldWorks.Common.PrintLayout.Page

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Must not be virtual.

Retrieves the page element that corresponds to the given stream. If multiple elements correspond to this stream, it gets the one with the smallest offset in the division (i.e., the one which corresponds to the highest place in the total document).

Gets the position of the point pt on the page.

Gets the number of printer pixels (source/layout units) from the top of the given division's main layout stream to the top of the data represented by the first page element on this page for that stream. This may only be an estimate, particularly if: this page has no elements (at least for the given division) this page is broken there are previous pages that are not fully laid out (or broken)

Public to make testing easier.

Constructs a Page object to represent a publication page that can be laid out.

Adds a page element, representing a layout stream in a particular location on the page.

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

Adds the separator for dependent stream.

Adjusts the free space.

Sets the offset to top of data, effectively breaking this page. This can be used on a page that may or may not have been laid out. Depending on the value of the page element parameter passed in, this can affect either the first division on the page or some subsequent division.

The Division uses this method to adjust the data offset value for the first division on a page that may or may not have been laid out. Typically this is necessary because the layout stream may have tweaked the offset so that it landed at a line break.

Adjusts the location and height of the page element as well as the available free space on the page.

True if the page is ready for drawing. When this is true, the page had better not get broken; otherwise, bad stuff will happen. For tests, we don't actually want to set this because we don't really draw the pages, so this flag never gets cleared. It's purpose in the production code is just to catch problems.

Draw as much of this page as will fit in the clip rectangle. We must draw something in every part of the clip rectangle (unless fScreen is false), because (to avoid flicker drawing selections) we don't erase the window before drawing. We do this by stretching the element horizontally, and separately erasing the areas between elements (and before and after them).

Gets the element bounds.

Gets the clip rectangle for the element depending on the whether the stream is left-to-right or right-to-left, and whether the next column has contents.

The clip rectangle for the element contains more then the element bounds so that we erase the surrounding background.

Insert a page element (at it's proper position so they are ordered top to bottom)

Perform the layout for each division that is to occupy space on this page.

Lay the page out if it has not already been done. Return true if anything had to be done.

Determines if the next column from the specified column has a page element.

When laying out a page in trial mode, notifies the page that the specified HVOs have been added to it.

Gets the number of printer pixels (source/layout units) from the top of the given division's main layout stream to the top of the data represented by the first page element on this page for that stream. This may only be an estimate, particularly if: this page has no elements (at least for the given division) this page is broken there are previous pages that are not fully laid out (or broken)

Determines the pe is more toward the trailing edge than the current lastMainElement.

This method checks for the possibility that, though the page got broken, nothing significant changed that affected the dependent object stream that has already been set up for this page. If this is the case we can mostly just keep things the way they are.