Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CObject►                                     ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation OLE Classes──────────────────────────────────────────
 
  Description
 
  COleClientItem is the Microsoft Foundation Class Library base class for
  Object Linking and Embedding (OLE) client items. A client item is a
  component of a compound document (OLE client document) and usually
  represents data in a particular format. Think of the client item as the
  client application's view of data provided by the server. This data
  could be contained in a child window, be represented directly in some
  region of the main window, or be invisible.
 
  Note Windows 3.1 OLE documentation refers to client items as "objects."
  This reference uses the term "item" to differentiate the OLE entity from
  the corresponding C++ class object.
 
  #include <afxole.h>
 
  See Also
 
      ◄COleClientDoc►
 
  Public Members
 
  Construction/Destruction
 
  ◄COleClientItem►   Constructs a COleClientItem object.
 
  ◄~COleClientItem►   Destroys the object.
 
  Creation
 
  ◄CreateFromClipboard►         Creates an embedded OLE item from the
                                Clipboard.
 
  ◄CreateStaticFromClipboard►   Creates an embedded picture of an OLE item
                                from the Clipboard.
 
  ◄CreateLinkFromClipboard►     Creates a linked OLE item from the
                                Clipboard.
 
  ◄CreateNewObject►             Creates a new (empty) embedded OLE item.
 
  ◄CreateCloneFrom►             Creates a new OLE item from an existing
                                OLE item.
 
  Status
 
  ◄GetLastStatus►   Returns the status of the last OLE operation.
 
  ◄GetType►         Returns the type of an OLE item.
 
  ◄GetName►         Returns the name of an OLE item.
 
  ◄GetSize►         Returns the size of an OLE item.
 
  ◄GetBounds►       Returns the bounds of an OLE item's rectangle.
 
  ◄IsOpen►          Indicates whether the item is currently attached to
                    the OLE dynamic-link libraries.
 
  Data Access
 
  ◄EnumFormats►   Enumerates the Clipboard formats supported.
 
  ◄GetData►       Gets data from an item in a specified format.
 
  ◄SetData►       Stores data to an item in a specified format.
 
  ◄RequestData►   Initiates a data request from a server.
 
  ◄IsEqual►       Compares OLE items.
 
  ◄GetDocument►   Returns the COleClientDoc object that contains this
                  item.
 
  Global State
 
  ◄InWaitForRelease►   Indicates whether any item is still waiting for a
                       server to respond.
 
  Clipboard Helpers
 
  ◄CanPaste►       Indicates whether the Clipboard contains an embedded or
                   static OLE item.
 
  ◄CanPasteLink►   Indicates whether the Clipboard contains a linked OLE
                   item.
 
  Linked Object Status
 
  ◄GetLinkUpdateOptions►   Returns the update mode for a linked OLE item
                           (advanced feature).
 
  ◄SetLinkUpdateOptions►   Sets the update mode for a linked OLE item
                           (advanced feature).
 
  General Operations
 
  ◄Release►         Releases the connection to an OLE linked item and
                    closes it if it was open. Does not destroy the server
                    item.
 
  ◄Delete►          Deletes an embedded or linked OLE item, including the
                    server data.
 
  ◄Draw►            Draws an OLE item.
 
  ◄Activate►        Opens an item for an operation, then executes a
                    specified verb.
 
  ◄WaitForServer►   Waits for a server to respond to a request.
 
  Advanced Operations
 
  ◄Rename►            Renames an OLE item.
 
  ◄CopyToClipboard►   Copies an OLE item to the Clipboard.
 
  ◄SetTargetDevice►   Sets the target device used by the server to draw an
                      OLE item.
 
  Embedded Object Operations
 
  ◄SetHostNames►     Sets the names the server displays when editing an
                     OLE item.
 
  ◄SetBounds►        Sets the size of the OLE client item's window
                     rectangle.
 
  ◄SetColorScheme►   Sets the OLE item's color scheme.
 
  Linked Object Operations
 
  ◄UpdateLink►      Updates a link to a server.
 
  ◄CloseLink►       Closes a link to a server but does not destroy the OLE
                    item.
 
  ◄ReconnectLink►   Reconnects a linked OLE item to a server.
 
  ◄FreezeLink►      Changes a linked OLE item into an embedded OLE item.
 
  Overridables (callbacks)
 
  ◄ReportError►   A customizable error-reporting function.
 
  Protected Members
 
  Overridables (callbacks)
 
  ◄OnChange►    Called when the server changes an OLE item.
 
  ◄OnRenamed►   Called when the server renames an OLE item.
 
 
                                     -♦-