Public Member Functions | List of all members
IPlotterForm Struct Referenceabstract

Plotter paper size. More...

#include <IPlotter.h>

Public Member Functions

virtual IPlotterFormP Clone () const =0
 Clones this form. More...
 
virtual void SetName (WCharCP value)=0
 Sets the form name. More...
 
virtual void GetName (WStringR value) const =0
 Gets the form name. More...
 
virtual void SetActualName (WCharCP value)=0
 Sets the form actual name. More...
 
virtual void GetActualName (WStringR value) const =0
 Gets the form actual name. More...
 
virtual void SetUnits (PlotUnits value)=0
 Sets the form units. More...
 
virtual PlotUnits GetUnits () const =0
 Gets the form units. More...
 
virtual void SetOrientation (PlotOrientation value)=0
 Sets the form orientation. More...
 
virtual PlotOrientation GetOrientation () const =0
 Gets the form orientation. More...
 
virtual bool IsFormSizeIdentical (IPlotterFormCP plotterForm, bool comparePrintableArea) const =0
 Indicates whether this form has the same size as the specified form. More...
 
virtual void SetTotalSize (DPoint2d value, PlotUnits units)=0
 Sets the form total size. More...
 
virtual DPoint2d GetTotalSize (PlotUnits units) const =0
 Gets the form total size. More...
 
virtual void SetPrintableSize (DPoint2d value, PlotUnits units)=0
 Sets the form printable size. More...
 
virtual DPoint2d GetPrintableSize (PlotUnits units) const =0
 Gets the form printable size. More...
 
virtual void SetPrintableOffset (DPoint2d value, PlotUnits units)=0
 Sets the form printable offset. More...
 
virtual DPoint2d GetPrintableOffset (PlotUnits units) const =0
 Gets the form printable offset. More...
 
virtual void SetPaperSizeNumber (int value)=0
 Sets the form paper size number. More...
 
virtual int GetPaperSizeNumber () const =0
 Gets the form paper size number. More...
 
virtual void SetFormIndex (int value)=0
 Sets the form index. More...
 
virtual int GetFormIndex () const =0
 Gets the form index. More...
 
virtual void SetDefaultFormScale (double value)=0
 Sets the form default scale. More...
 
virtual double GetDefaultFormScale () const =0
 Gets the form default scale. More...
 
virtual void SetLineWeightScale (double value)=0
 Sets the form line weight scale. More...
 
virtual double GetLineWeightScale () const =0
 Gets the form line weight scale. More...
 
virtual void SetLineStyleScale (double value)=0
 Sets the form line style scale. More...
 
virtual double GetLineStyleScale () const =0
 Gets the form line style scale. More...
 
virtual void SetAutoRotate (PlotRotateDir value)=0
 Sets the form auto rotation direction. More...
 
virtual PlotRotateDir GetAutoRotate () const =0
 Gets the form auto rotation direction. More...
 
virtual bool IsNoneForm () const =0
 Indicates whether this form is the reserved "NONE" form. More...
 

Detailed Description

Plotter paper size.

Member Function Documentation

virtual IPlotterFormP Clone ( ) const
pure virtual

Clones this form.

virtual void GetActualName ( WStringR  value) const
pure virtual

Gets the form actual name.

virtual PlotRotateDir GetAutoRotate ( ) const
pure virtual

Gets the form auto rotation direction.

virtual double GetDefaultFormScale ( ) const
pure virtual

Gets the form default scale.

virtual int GetFormIndex ( ) const
pure virtual

Gets the form index.

virtual double GetLineStyleScale ( ) const
pure virtual

Gets the form line style scale.

virtual double GetLineWeightScale ( ) const
pure virtual

Gets the form line weight scale.

virtual void GetName ( WStringR  value) const
pure virtual

Gets the form name.

virtual PlotOrientation GetOrientation ( ) const
pure virtual

Gets the form orientation.

virtual int GetPaperSizeNumber ( ) const
pure virtual

Gets the form paper size number.

virtual DPoint2d GetPrintableOffset ( PlotUnits  units) const
pure virtual

Gets the form printable offset.

virtual DPoint2d GetPrintableSize ( PlotUnits  units) const
pure virtual

Gets the form printable size.

virtual DPoint2d GetTotalSize ( PlotUnits  units) const
pure virtual

Gets the form total size.

virtual PlotUnits GetUnits ( ) const
pure virtual

Gets the form units.

virtual bool IsFormSizeIdentical ( IPlotterFormCP  plotterForm,
bool  comparePrintableArea 
) const
pure virtual

Indicates whether this form has the same size as the specified form.

virtual bool IsNoneForm ( ) const
pure virtual

Indicates whether this form is the reserved "NONE" form.

Remarks
The NONE form is used in conjunction with InterPlot Server.
virtual void SetActualName ( WCharCP  value)
pure virtual

Sets the form actual name.

virtual void SetAutoRotate ( PlotRotateDir  value)
pure virtual

Sets the form auto rotation direction.

virtual void SetDefaultFormScale ( double  value)
pure virtual

Sets the form default scale.

virtual void SetFormIndex ( int  value)
pure virtual

Sets the form index.

virtual void SetLineStyleScale ( double  value)
pure virtual

Sets the form line style scale.

virtual void SetLineWeightScale ( double  value)
pure virtual

Sets the form line weight scale.

virtual void SetName ( WCharCP  value)
pure virtual

Sets the form name.

virtual void SetOrientation ( PlotOrientation  value)
pure virtual

Sets the form orientation.

virtual void SetPaperSizeNumber ( int  value)
pure virtual

Sets the form paper size number.

virtual void SetPrintableOffset ( DPoint2d  value,
PlotUnits  units 
)
pure virtual

Sets the form printable offset.

virtual void SetPrintableSize ( DPoint2d  value,
PlotUnits  units 
)
pure virtual

Sets the form printable size.

virtual void SetTotalSize ( DPoint2d  value,
PlotUnits  units 
)
pure virtual

Sets the form total size.

virtual void SetUnits ( PlotUnits  value)
pure virtual

Sets the form units.


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

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