CgmFile (Aspose.CAD for Java module 25.10 API Documentation)

java.lang.Object
- com.aspose.cad.fileformats.cgm.CgmFile

```
public class CgmFile
extends Object
```
CGM image class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyValues(CgmFile file)` Copies the current meta information
`boolean`	`containsConsumableNumber(String textToCheck)` Determines whether CGM contains a specific consumable number text
`boolean`	`containsFigureItemText(String textToCheck)` Determines whether CGM contains a specific figure item text.
`boolean`	`containsTextElement(String text)` Determines whether any text element equals the specified text.
`boolean`	`containsTorqueTextToFigItem(String torqueText, String figureItemNumber)` Determines whether the torque text ("20 Nm (177 lb-in)" exists nearby the figure item)
`int`	`getColourIndexPrecision()` Gets or sets the current reading colour index precision
`int`	`getColourModel()` Gets or sets the current reading colour model
`int`	`getColourPrecision()` Gets or sets the current reading colour precision
`ColourSelectionMode.Type`	`getColourSelectionMode()` Gets or sets the current reading colour selecion mode
`int[]`	`getColourValueExtentMaximumColorValueRGB()` Gets or sets the current reading MaximumColorValueRGB
`int[]`	`getColourValueExtentMinimumColorValueRGB()` Gets or sets the current reading MinimumColorValueRGB
`List<Command>`	`getCommands()` The read CGM commands
`DeviceViewportSpecificationMode.Mode`	`getDeviceViewportSpecificationMode()` Gets or sets the current reading DeviceViewportSpecificationMode
`SpecificationMode`	`getEdgeWidthSpecificationMode()` Gets or sets the current reading EdgeWidthSpecificationMode
`List<String>`	`getFigureItemTexts(boolean ignoreColor)` Gets all texts of the figure items.
`String`	`getGraphicName()` Gets the title of the illustration.
`int`	`getIndexPrecision()` Gets or sets the current reading Index Precision
`TextInformation`	`getInformation(TextCommand command)`
`int`	`getIntegerPrecision()` Gets or sets the current reading integer Precision
`SpecificationMode`	`getInteriorStyleSpecificationMode()` Gets or sets the current reading interior style SpecificationMode
`SpecificationMode`	`getLineWidthSpecificationMode()` Gets or sets the current reading LineWidthSpecificationMode
`SpecificationMode`	`getMarkerSizeSpecificationMode()` Gets or sets the current reading MarkerSizeSpecificationMode
`com.aspose.ms.System.Collections.Generic.IGenericEnumerable<Message>`	`getMessages()` Any messages occured while reading or writing the file
`String`	`getMetaTitle()` Gets the title.
`String`	`getName()` Gets the name of the file
`int`	`getNamePrecision()` Gets or sets the current reading name Precision
`Precision`	`getRealPrecision()` Gets or sets the current reading real Precision
`boolean`	`getRealPrecisionProcessed()` Gets or sets the current reading real Precision processed flag
`List<CgmRectangle>`	`getRectangles()` Gets all found rectangles.
`int`	`getRestrictedTextType()` Gets or sets the current reading RestrictedTextType
`int`	`getVDCIntegerPrecision()` Gets or sets the current reading vdc integer Precision
`Precision`	`getVDCRealPrecision()` Gets or sets the current reading vdc real Precision
`VdcType.Type`	`getVDCType()` Gets or sets the current reading VDC Type
`boolean`	`isWrittenDownToUp(TextCommand command)` Determines whether text is rotated 90 dec counterwise
`void`	`resetMetaDefinitions()` Resets settings like VDCRealPrecision or ColourModel
`void`	`setColourIndexPrecision(int value)` Gets or sets the current reading colour index precision
`void`	`setColourModel(int value)` Gets or sets the current reading colour model
`void`	`setColourPrecision(int value)` Gets or sets the current reading colour precision
`void`	`setColourSelectionMode(ColourSelectionMode.Type value)` Gets or sets the current reading colour selecion mode
`void`	`setColourValueExtentMaximumColorValueRGB(int[] value)` Gets or sets the current reading MaximumColorValueRGB
`void`	`setColourValueExtentMinimumColorValueRGB(int[] value)` Gets or sets the current reading MinimumColorValueRGB
`void`	`setDeviceViewportSpecificationMode(DeviceViewportSpecificationMode.Mode value)` Gets or sets the current reading DeviceViewportSpecificationMode
`void`	`setEdgeWidthSpecificationMode(SpecificationMode value)` Gets or sets the current reading EdgeWidthSpecificationMode
`void`	`setIndexPrecision(int value)` Gets or sets the current reading Index Precision
`void`	`setIntegerPrecision(int value)` Gets or sets the current reading integer Precision
`void`	`setInteriorStyleSpecificationMode(SpecificationMode value)` Gets or sets the current reading interior style SpecificationMode
`void`	`setLineWidthSpecificationMode(SpecificationMode value)` Gets or sets the current reading LineWidthSpecificationMode
`void`	`setMarkerSizeSpecificationMode(SpecificationMode value)` Gets or sets the current reading MarkerSizeSpecificationMode
`void`	`setNamePrecision(int value)` Gets or sets the current reading name Precision
`void`	`setRealPrecision(Precision value)` Gets or sets the current reading real Precision
`void`	`setRealPrecisionProcessed(boolean value)` Gets or sets the current reading real Precision processed flag
`void`	`setRestrictedTextType(int value)` Gets or sets the current reading RestrictedTextType
`void`	`setVDCIntegerPrecision(int value)` Gets or sets the current reading vdc integer Precision
`void`	`setVDCRealPrecision(Precision value)` Gets or sets the current reading vdc real Precision
`void`	`setVDCType(VdcType.Type value)` Gets or sets the current reading VDC Type

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - resetMetaDefinitions
```
public final void resetMetaDefinitions()
```
    Resets settings like VDCRealPrecision or ColourModel
  - applyValues
```
public final void applyValues(CgmFile file)
```
    Copies the current meta information
    
    Parameters:
    
    file - The cgm file to copy from
  - getName
```
public final String getName()
```
    Gets the name of the file
  - getColourIndexPrecision
```
public final int getColourIndexPrecision()
```
    Gets or sets the current reading colour index precision
  - setColourIndexPrecision
```
public final void setColourIndexPrecision(int value)
```
    Gets or sets the current reading colour index precision
  - getColourPrecision
```
public final int getColourPrecision()
```
    Gets or sets the current reading colour precision
  - setColourPrecision
```
public final void setColourPrecision(int value)
```
    Gets or sets the current reading colour precision
  - getColourModel
```
public final int getColourModel()
```
    Gets or sets the current reading colour model
  - setColourModel
```
public final void setColourModel(int value)
```
    Gets or sets the current reading colour model
  - getColourSelectionMode
```
public final ColourSelectionMode.Type getColourSelectionMode()
```
    Gets or sets the current reading colour selecion mode
  - setColourSelectionMode
```
public final void setColourSelectionMode(ColourSelectionMode.Type value)
```
    Gets or sets the current reading colour selecion mode
  - getColourValueExtentMinimumColorValueRGB
```
public final int[] getColourValueExtentMinimumColorValueRGB()
```
    Gets or sets the current reading MinimumColorValueRGB
  - setColourValueExtentMinimumColorValueRGB
```
public final void setColourValueExtentMinimumColorValueRGB(int[] value)
```
    Gets or sets the current reading MinimumColorValueRGB
  - getColourValueExtentMaximumColorValueRGB
```
public final int[] getColourValueExtentMaximumColorValueRGB()
```
    Gets or sets the current reading MaximumColorValueRGB
  - setColourValueExtentMaximumColorValueRGB
```
public final void setColourValueExtentMaximumColorValueRGB(int[] value)
```
    Gets or sets the current reading MaximumColorValueRGB
  - getDeviceViewportSpecificationMode
```
public final DeviceViewportSpecificationMode.Mode getDeviceViewportSpecificationMode()
```
    Gets or sets the current reading DeviceViewportSpecificationMode
  - setDeviceViewportSpecificationMode
```
public final void setDeviceViewportSpecificationMode(DeviceViewportSpecificationMode.Mode value)
```
    Gets or sets the current reading DeviceViewportSpecificationMode
  - getEdgeWidthSpecificationMode
```
public final SpecificationMode getEdgeWidthSpecificationMode()
```
    Gets or sets the current reading EdgeWidthSpecificationMode
  - setEdgeWidthSpecificationMode
```
public final void setEdgeWidthSpecificationMode(SpecificationMode value)
```
    Gets or sets the current reading EdgeWidthSpecificationMode
  - getIndexPrecision
```
public final int getIndexPrecision()
```
    Gets or sets the current reading Index Precision
  - setIndexPrecision
```
public final void setIndexPrecision(int value)
```
    Gets or sets the current reading Index Precision
  - getIntegerPrecision
```
public final int getIntegerPrecision()
```
    Gets or sets the current reading integer Precision
  - setIntegerPrecision
```
public final void setIntegerPrecision(int value)
```
    Gets or sets the current reading integer Precision
  - getNamePrecision
```
public final int getNamePrecision()
```
    Gets or sets the current reading name Precision
  - setNamePrecision
```
public final void setNamePrecision(int value)
```
    Gets or sets the current reading name Precision
  - getVDCIntegerPrecision
```
public final int getVDCIntegerPrecision()
```
    Gets or sets the current reading vdc integer Precision
  - setVDCIntegerPrecision
```
public final void setVDCIntegerPrecision(int value)
```
    Gets or sets the current reading vdc integer Precision
  - getVDCRealPrecision
```
public final Precision getVDCRealPrecision()
```
    Gets or sets the current reading vdc real Precision
  - setVDCRealPrecision
```
public final void setVDCRealPrecision(Precision value)
```
    Gets or sets the current reading vdc real Precision
  - getRealPrecision
```
public final Precision getRealPrecision()
```
    Gets or sets the current reading real Precision
  - setRealPrecision
```
public final void setRealPrecision(Precision value)
```
    Gets or sets the current reading real Precision
  - getRealPrecisionProcessed
```
public final boolean getRealPrecisionProcessed()
```
    Gets or sets the current reading real Precision processed flag
  - setRealPrecisionProcessed
```
public final void setRealPrecisionProcessed(boolean value)
```
    Gets or sets the current reading real Precision processed flag
  - getLineWidthSpecificationMode
```
public final SpecificationMode getLineWidthSpecificationMode()
```
    Gets or sets the current reading LineWidthSpecificationMode
  - setLineWidthSpecificationMode
```
public final void setLineWidthSpecificationMode(SpecificationMode value)
```
    Gets or sets the current reading LineWidthSpecificationMode
  - getMarkerSizeSpecificationMode
```
public final SpecificationMode getMarkerSizeSpecificationMode()
```
    Gets or sets the current reading MarkerSizeSpecificationMode
  - setMarkerSizeSpecificationMode
```
public final void setMarkerSizeSpecificationMode(SpecificationMode value)
```
    Gets or sets the current reading MarkerSizeSpecificationMode
  - getInteriorStyleSpecificationMode
```
public final SpecificationMode getInteriorStyleSpecificationMode()
```
    Gets or sets the current reading interior style SpecificationMode
  - setInteriorStyleSpecificationMode
```
public final void setInteriorStyleSpecificationMode(SpecificationMode value)
```
    Gets or sets the current reading interior style SpecificationMode
  - getRestrictedTextType
```
public final int getRestrictedTextType()
```
    Gets or sets the current reading RestrictedTextType
  - setRestrictedTextType
```
public final void setRestrictedTextType(int value)
```
    Gets or sets the current reading RestrictedTextType
  - getVDCType
```
public final VdcType.Type getVDCType()
```
    Gets or sets the current reading VDC Type
  - setVDCType
```
public final void setVDCType(VdcType.Type value)
```
    Gets or sets the current reading VDC Type
  - getCommands
```
public final List<Command> getCommands()
```
    The read CGM commands
  - containsTextElement
```
public final boolean containsTextElement(String text)
```
    Determines whether any text element equals the specified text.
    
    Parameters:
    
    text - The text.
    
    Returns:
  - getMetaTitle
```
public final String getMetaTitle()
```
    Gets the title.
    
    Returns:
  - getGraphicName
```
public final String getGraphicName()
```
    Gets the title of the illustration.
    
    Returns:
  - getFigureItemTexts
```
public final List<String> getFigureItemTexts(boolean ignoreColor)
```
    Gets all texts of the figure items.
    
    Returns:
  - containsFigureItemText
```
public final boolean containsFigureItemText(String textToCheck)
```
    Determines whether CGM contains a specific figure item text.
    
    Parameters:
    
    textToCheck - The text to check.
    
    Returns:
  - containsConsumableNumber
```
public final boolean containsConsumableNumber(String textToCheck)
```
    Determines whether CGM contains a specific consumable number text
    
    Parameters:
    
    textToCheck - The text to check.
    
    Returns:
  - containsTorqueTextToFigItem
```
public final boolean containsTorqueTextToFigItem(String torqueText,
                                                 String figureItemNumber)
```
    Determines whether the torque text ("20 Nm (177 lb-in)" exists nearby the figure item)
    
    Parameters:
    
    torqueText - The torque text.
    
    figureItemNumber - The figure item number.
    
    Returns:
    
    true if [contains torque text to fig item] [the specified torque text]; otherwise, false.
  - getInformation
```
public final TextInformation getInformation(TextCommand command)
```
  - isWrittenDownToUp
```
public final boolean isWrittenDownToUp(TextCommand command)
```
    Determines whether text is rotated 90 dec counterwise
    
    Parameters:
    
    command - The command.
  - getRectangles
```
public final List<CgmRectangle> getRectangles()
```
    Gets all found rectangles.
    
    Returns:
  - getMessages
```
public final com.aspose.ms.System.Collections.Generic.IGenericEnumerable<Message> getMessages()
```
    Any messages occured while reading or writing the file

Class CgmFile

Method Summary

Methods inherited from class java.lang.Object

Method Detail

resetMetaDefinitions

applyValues

getName

getColourIndexPrecision

setColourIndexPrecision

getColourPrecision

setColourPrecision

getColourModel

setColourModel

getColourSelectionMode

setColourSelectionMode

getColourValueExtentMinimumColorValueRGB

setColourValueExtentMinimumColorValueRGB

getColourValueExtentMaximumColorValueRGB

setColourValueExtentMaximumColorValueRGB

getDeviceViewportSpecificationMode

setDeviceViewportSpecificationMode

getEdgeWidthSpecificationMode

setEdgeWidthSpecificationMode

getIndexPrecision

setIndexPrecision

getIntegerPrecision

setIntegerPrecision

getNamePrecision

setNamePrecision

getVDCIntegerPrecision

setVDCIntegerPrecision

getVDCRealPrecision

setVDCRealPrecision

getRealPrecision

setRealPrecision

getRealPrecisionProcessed

setRealPrecisionProcessed

getLineWidthSpecificationMode

setLineWidthSpecificationMode

getMarkerSizeSpecificationMode

setMarkerSizeSpecificationMode

getInteriorStyleSpecificationMode

setInteriorStyleSpecificationMode

getRestrictedTextType

setRestrictedTextType

getVDCType

setVDCType

getCommands

containsTextElement

getMetaTitle

getGraphicName

getFigureItemTexts

containsFigureItemText

containsConsumableNumber

containsTorqueTextToFigItem

getInformation

isWrittenDownToUp

getRectangles

getMessages