Public Member Functions | List of all members
IPlotBeginElementParam Struct Referenceabstract

Parameters for the BeginElement print event. More...

#include <IPlotHook.h>

Public Member Functions

virtual ElementHandleCP GetElemHandleCP () const =0
 Gets the element handle. More...
 
virtual MSElementDescrCP GetElementDescrCP () const =0
 Gets the element descriptor. More...
 
virtual PlotElemParamStackCR GetElementStack () const =0
 Gets the element parameter stack. More...
 
virtual ElementHandleCP GetOriginalElemHandleCP () const =0
 Gets the original element handle. More...
 
virtual ElementHandleCP GetReplacementElemHandleCP () const =0
 Gets the original element descriptor. More...
 
virtual bool IsElementIgnored () const =0
 True if the print engine has been instructed not to print this element. More...
 
virtual void IgnoreElement ()=0
 Instruct the print engine not to print this element. More...
 
virtual MSElementDescrCP ReplaceElement (MSElementDescrCP edP)=0
 Temporarily replace the original element with the specified one when printing. More...
 
virtual void ReplaceTextString (WCharCP textString)=0
 Replace all text strings inside this element with the given string. More...
 
virtual void ReplaceTextFont (UInt32 fontNum)=0
 Replace all text fonts inside this element with the given font number. More...
 
virtual void SetSortOrder (int sortOrder)=0
 Sets the post-stroke sort order. More...
 
virtual void SetPostStrokeLineStyleIndex (int lineStyleIndex)=0
 Sets the post-stroke line style index. More...
 
virtual void SetIsTextBoundaryColorValid (bool value)=0
 Indicates that the text boundary color has been set. More...
 
virtual void SetTextBoundaryColor (UInt32 color)=0
 Sets the text boundary color. More...
 

Detailed Description

Parameters for the BeginElement print event.

Member Function Documentation

virtual MSElementDescrCP GetElementDescrCP ( ) const
pure virtual

Gets the element descriptor.

virtual PlotElemParamStackCR GetElementStack ( ) const
pure virtual

Gets the element parameter stack.

virtual ElementHandleCP GetElemHandleCP ( ) const
pure virtual

Gets the element handle.

virtual ElementHandleCP GetOriginalElemHandleCP ( ) const
pure virtual

Gets the original element handle.

Remarks
May differ from GetElemHandleCP() if another print event handler has replaced the element.
virtual ElementHandleCP GetReplacementElemHandleCP ( ) const
pure virtual

Gets the original element descriptor.

Remarks
May differ from GetElementDescrCP() if another print event handler has replaced the element.
virtual void IgnoreElement ( )
pure virtual

Instruct the print engine not to print this element.

virtual bool IsElementIgnored ( ) const
pure virtual

True if the print engine has been instructed not to print this element.

virtual MSElementDescrCP ReplaceElement ( MSElementDescrCP  edP)
pure virtual

Temporarily replace the original element with the specified one when printing.

virtual void ReplaceTextFont ( UInt32  fontNum)
pure virtual

Replace all text fonts inside this element with the given font number.

virtual void ReplaceTextString ( WCharCP  textString)
pure virtual

Replace all text strings inside this element with the given string.

virtual void SetIsTextBoundaryColorValid ( bool  value)
pure virtual

Indicates that the text boundary color has been set.

virtual void SetPostStrokeLineStyleIndex ( int  lineStyleIndex)
pure virtual

Sets the post-stroke line style index.

Remarks
Only supported when printing in non-rasterized mode.
virtual void SetSortOrder ( int  sortOrder)
pure virtual

Sets the post-stroke sort order.

Remarks
Only supported when printing in non-rasterized mode.
virtual void SetTextBoundaryColor ( UInt32  color)
pure virtual

Sets the text boundary color.


The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.