NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Display.StudioImageCaptureBuilder Class Reference

Represents a NXOpen.Display.StudioImageCaptureBuilder More...

Inheritance diagram for NXOpen.Display.StudioImageCaptureBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AASamplesEnumType {
  Sam0X, Sam2X, Sam4X, Sam8X,
  Sam16X
}
 Provide the following anti-aliasing sample size for off screen image capture More...
 
enum  DPIEnumType { Dpi72, Dpi150 }
 Provide the following screen capture resolutions in dots per inch More...
 
enum  DrawingSizeEnumType {
  Isoa4, Isoa3, Isoa2, Isoa1,
  Isoa0, Ansia, Ansib, Ansic,
  Ansid, Ansie, Custom
}
 Provide the following standard Drawing sizes More...
 
enum  OrientEnumType { Landscape, Portrait }
 Provide the following options to image orientation More...
 
enum  UnitsEnumType { Pixels, Mm, Inches }
 Provide the following resolution unit options to screen capture More...
 

Public Member Functions

unsafe double[] GetImageDimensionsDouble ()
 Gets the double image dimensions, height and width More...
 
unsafe int[] GetImageDimensionsInteger ()
 Gets the integer image dimensions, height and width More...
 
unsafe void SetImageDimensionsDouble (double[] imageDimensionsDouble)
 Sets the double image dimensions, height and width More...
 
unsafe void SetImageDimensionsInteger (int[] imageDimensionsInteger)
 Sets the integer image dimensions, height and width More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Display.StudioImageCaptureBuilder.AASamplesEnumType 
AASamplesEnum [get, set]
 Returns or sets the antialiasing samples enum More...
 
unsafe
NXOpen.Display.StudioImageCaptureBuilder.DPIEnumType 
DpiEnum [get, set]
 Returns or sets the dpi enum More...
 
unsafe
NXOpen.Display.StudioImageCaptureBuilder.DrawingSizeEnumType 
DrawingSizeEnum [get, set]
 Returns or sets the drawing size enum More...
 
unsafe string NativeFileBrowser [get, set]
 Returns or sets the native file browser for image type to produce More...
 
unsafe
NXOpen.Display.StudioImageCaptureBuilder.OrientEnumType 
OrientEnum [get, set]
 Returns or sets the orient enum More...
 
unsafe
NXOpen.Display.StudioImageCaptureBuilder.UnitsEnumType 
UnitsEnum [get, set]
 Returns or sets the units enum More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Display.StudioImageCaptureBuilder

This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return a null reference (Nothing in Visual Basic).

To create a new instance of this class, use NXOpen.ViewCollection.CreateStudioImageCaptureBuilder

Default values.

Property Value

AASamplesEnum

Sam0X

DpiEnum

Dpi72

DrawingSizeEnum

Isoa4

OrientEnum

Landscape

UnitsEnum

Pixels

Created in NX6.0.4

Member Enumeration Documentation

Provide the following anti-aliasing sample size for off screen image capture

Enumerator
Sam0X 

Do not set sampling option

Sam2X 

Set sampling at 2 times

Sam4X 

Set sampling at 4 times

Sam8X 

Set sampling at 8 times

Sam16X 

Set sampling at 16 times

Provide the following screen capture resolutions in dots per inch

Enumerator
Dpi72 

Set image at 72 DPI resolution

Dpi150 

Set image at 150 DPI resolution

Provide the following standard Drawing sizes

Enumerator
Isoa4 

Use ISO A4 drawing size

Isoa3 

Use ISO A3 drawing size

Isoa2 

Use ISO A2 drawing size

Isoa1 

Use ISO A1 drawing size

Isoa0 

Use ISO A0 drawing size

Ansia 

Use ANSI A drawing size

Ansib 

Use ANSI B drawing size

Ansic 

Use ANSI C drawing size

Ansid 

Use ANSI D drawing size

Ansie 

Use ANSI E drawing size

Custom 

Use custom defined drawing size

Provide the following options to image orientation

Enumerator
Landscape 

Capture image in landscape mode

Portrait 

Capture image in portrait mode

Provide the following resolution unit options to screen capture

Enumerator
Pixels 

Use pixel to define resolution

Mm 

Use Millimeters to define resolution

Inches 

Use Inched to define resolution

Member Function Documentation

unsafe double [] NXOpen.Display.StudioImageCaptureBuilder.GetImageDimensionsDouble ( )
inline

Gets the double image dimensions, height and width

Created in NX6.0.4

License requirements: None.

Returns
array of 2 doubles
unsafe int [] NXOpen.Display.StudioImageCaptureBuilder.GetImageDimensionsInteger ( )
inline

Gets the integer image dimensions, height and width

Created in NX6.0.4

License requirements: None.

Returns
array of 2 integers
unsafe void NXOpen.Display.StudioImageCaptureBuilder.SetImageDimensionsDouble ( double[]  imageDimensionsDouble)
inline

Sets the double image dimensions, height and width

Created in NX6.0.4

License requirements: None.

Parameters
imageDimensionsDoublearray of 2 doubles
unsafe void NXOpen.Display.StudioImageCaptureBuilder.SetImageDimensionsInteger ( int[]  imageDimensionsInteger)
inline

Sets the integer image dimensions, height and width

Created in NX6.0.4

License requirements: None.

Parameters
imageDimensionsIntegerarray of 2 integers

Property Documentation

unsafe NXOpen.Display.StudioImageCaptureBuilder.AASamplesEnumType NXOpen.Display.StudioImageCaptureBuilder.AASamplesEnum
getset

Returns or sets the antialiasing samples enum

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.StudioImageCaptureBuilder.DPIEnumType NXOpen.Display.StudioImageCaptureBuilder.DpiEnum
getset

Returns or sets the dpi enum

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.StudioImageCaptureBuilder.DrawingSizeEnumType NXOpen.Display.StudioImageCaptureBuilder.DrawingSizeEnum
getset

Returns or sets the drawing size enum

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Display.StudioImageCaptureBuilder.NativeFileBrowser
getset

Returns or sets the native file browser for image type to produce

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.StudioImageCaptureBuilder.OrientEnumType NXOpen.Display.StudioImageCaptureBuilder.OrientEnum
getset

Returns or sets the orient enum

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.StudioImageCaptureBuilder.UnitsEnumType NXOpen.Display.StudioImageCaptureBuilder.UnitsEnum
getset

Returns or sets the units enum

Created in NX6.0.4

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.