A Sandcastle Documented Class Library
GifFrame Class
NamespacesGifComponentsGifFrame
A single image frame from a GIF file. Originally a nested class within the GifDecoder class by Kevin Weiner. Downloaded from http://www.thinkedge.com/BlogEngine/file.axd?file=NGif_src2.zip Amended by Simon Bridewell June-November 2009: 1. Made member variables private. 2. Added various properties to expose all the elements of the GifFrame. 3. Added constructors for use in both encoding and decoding. 4. Derive from GifComponent. 5. Added FromStream method
Declaration Syntax
C#Visual BasicVisual C++
public class GifFrame : GifComponent
Public Class GifFrame _
	Inherits GifComponent
public ref class GifFrame : public GifComponent
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
GifFrame(Image)
Constructor.

GifFrame(TableBasedImageData, ColourTable, ImageDescriptor, GraphicControlExtension, Color, LogicalScreenDescriptor, GifFrame, GifFrame)
Constructor.

BackgroundColour
Gets and sets the background colour of the current frame

ComponentStatus
Gets the status of this component, consisting of its error state and any associated error message.
(Inherited from GifComponent.)
ConsolidatedState
Gets the combined error states of this component and all its child components.
(Inherited from GifComponent.)
Delay
Gets and sets the delay in hundredths of a second before showing the next frame.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ErrorMessage
Gets any error message associated with the component's error state.
(Inherited from GifComponent.)
ErrorState
Gets the member of the Gif.Components.ErrorState enumeration held within the ComponentStatus property.
(Inherited from GifComponent.)
ExpectsUserInput
Gets a flag indicating whether the device displaying the animation should wait for user input (e.g. a mouse click or key press) before displaying the next frame.

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FromStream(Stream, LogicalScreenDescriptor, ColourTable, GraphicControlExtension, GifFrame, GifFrame)
Creates and returns a GifFrame by reading its data from the supplied input stream.

GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GraphicControlExtension
Gets the graphic control extension which precedes this image.

ImageDescriptor
Gets the image descriptor for this frame.

IndexedPixels
Gets the table-based image data containing the indices within the active colour table of the colours of each of the pixels in the frame.

LocalColourTable
Gets the local colour table for this frame.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Position
Gets and sets the position of this frame's image within the logical screen.

SetStatus(ErrorState, String)
Sets the ComponentStatus property of thie GifComponent.
(Inherited from GifComponent.)
TestState(ErrorState)
Tests whether the error state of this component or any of its member components contains the supplied member of the ErrorState enumeration.
(Inherited from GifComponent.)
TheImage
Gets the image held in this frame.

ToString()()()
Gets a string representation of the error status of this component and its subcomponents.
(Inherited from GifComponent.)
WriteToStream(Stream)
Writes this component to the supplied output stream.
(Overrides GifComponent.WriteToStream(Stream).)
Inheritance Hierarchy

Assembly: GifComponents (Module: GifComponents) Version: 0.1.3594.26453