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

Contains wrappers for all 'UF_PLOT' functions and data types. More...

Inheritance diagram for NXOpen.UF.UFPlot:
NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _BannerOptions
 
struct  _PrinterGroup
 
struct  BannerOptions
 Wrapper for UF_PLOT_banner_options_s More...
 
struct  Extents
 Wrapper for UF_PLOT_extents_s More...
 
struct  JobOptions
 Wrapper for UF_PLOT_job_options_s More...
 
struct  PrinterGroup
 Wrapper for UF_PLOT_printer_group_s More...
 
struct  UghpglCmpOptions
 Wrapper for UF_PLOT_ughpgl_cmp_options_s More...
 

Public Types

enum  CmpColorWidth
 Wrapper for UF_PLOT_cmp_color_width_e More...
 
enum  Colors
 Wrapper for UF_PLOT_colors_e More...
 
enum  CreateCmpResultPlot
 Wrapper for UF_PLOT_create_cmp_result_plot_e More...
 
enum  DiffCmpStatus
 Wrapper for UF_PLOT_diff_cmp_status_e More...
 
enum  Format
 Wrapper for UF_PLOT_format_e More...
 
enum  Rotation
 Wrapper for UF_PLOT_rotation_e More...
 
enum  Units
 Wrapper for UF_PLOT_units_e More...
 
enum  Widths
 Wrapper for UF_PLOT_widths_e More...
 

Public Member Functions

void AddJobToPlotLayout (NXOpen.Tag drawing_sheet, ref JobOptions job_options, string job_name, Units units, double[] origin, Rotation rotation, double scale, out Extents extents)
 Wrapper method for UF_PLOT_add_job_to_plot_layout More...
 
unsafe void AskDefaultBannerOptions (out BannerOptions banner_options)
 Wrapper method for UF_PLOT_ask_default_banner_options More...
 
unsafe void AskDefaultCustomColors (out UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_ask_default_custom_colors More...
 
unsafe void AskDefaultCustomWidths (out UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_ask_default_custom_widths More...
 
unsafe void AskDefaultJobName (NXOpen.Tag drawing_sheet, out string job_name)
 Wrapper method for UF_PLOT_ask_default_job_name More...
 
void AskDefaultJobOptions (out JobOptions job_options)
 Wrapper method for UF_PLOT_ask_default_job_options More...
 
unsafe void AskDefaultPrinterAndProfile (out string printer, out string profile)
 Wrapper method for UF_PLOT_ask_default_printer_and_profile More...
 
unsafe void AskDrawingSheetColors (NXOpen.Tag drawing_sheet, out UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_ask_drawing_sheet_colors More...
 
unsafe void AskDrawingSheetWidths (NXOpen.Tag drawing_sheet, out UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_ask_drawing_sheet_widths More...
 
void AskPlotLayoutExtents (Units units, out Extents extents)
 Wrapper method for UF_PLOT_ask_plot_layout_extents More...
 
unsafe void AskPrinterGroups (out int num_printer_groups, out PrinterGroup[] printer_groups)
 Wrapper method for UF_PLOT_ask_printer_groups More...
 
unsafe void AskPrinterNames (out int num_printers, out string[] printers)
 Wrapper method for UF_PLOT_ask_printer_names More...
 
unsafe void AskProfileNames (string printer, out int num_profiles, out string[] profiles)
 Wrapper method for UF_PLOT_ask_profile_names More...
 
unsafe void AskSessionBannerOptions (out BannerOptions banner_options)
 Wrapper method for UF_PLOT_ask_session_banner_options More...
 
unsafe void AskSessionCustomColors (out UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_ask_session_custom_colors More...
 
unsafe void AskSessionCustomWidths (out UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_ask_session_custom_widths More...
 
void AskSessionJobOptions (out JobOptions job_options)
 Wrapper method for UF_PLOT_ask_session_job_options More...
 
void ClearPlotLayout ()
 Wrapper method for UF_PLOT_clear_plot_layout More...
 
void CompareUghpglFiles (string first_plot, string second_plot, ref UghpglCmpOptions compare_options, string result_plot, out DiffCmpStatus comparison_result)
 Wrapper method for UF_PLOT_compare_ughpgl_files More...
 
unsafe void ConvertCustomWidths (Units units, ref UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_convert_custom_widths More...
 
void ConvertFile (string cgm_or_tiff_file_name, Format output_format, string output_file_name)
 Wrapper method for UF_PLOT_convert_file More...
 
void DeleteDrawingSheetColors (NXOpen.Tag drawing_sheet)
 Wrapper method for UF_PLOT_delete_drawing_sheet_colors More...
 
void DeleteDrawingSheetWidths (NXOpen.Tag drawing_sheet)
 Wrapper method for UF_PLOT_delete_drawing_sheet_widths More...
 
void HasDrawingSheetColors (NXOpen.Tag drawing_sheet, out bool drawing_sheet_has_colors)
 Wrapper method for UF_PLOT_has_drawing_sheet_colors More...
 
void HasDrawingSheetWidths (NXOpen.Tag drawing_sheet, out bool drawing_sheet_has_widths)
 Wrapper method for UF_PLOT_has_drawing_sheet_widths More...
 
unsafe void Print (NXOpen.Tag drawing_sheet, ref JobOptions job_options, string job_name, ref BannerOptions banner_options, string printer, string profile, int num_copies)
 Wrapper method for UF_PLOT_print More...
 
void PrintFile (string filename, string printer, string profile, int num_copies)
 Wrapper method for UF_PLOT_print_file More...
 
unsafe void PrintPlotLayout (string job_name, ref BannerOptions banner_options, string printer, string profile, int num_copies)
 Wrapper method for UF_PLOT_print_plot_layout More...
 
unsafe void ReadCustomColorsFromCdf (string cdf_name, out UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_read_custom_colors_from_cdf More...
 
unsafe void ReadCustomWidthsFromWdf (string wdf_name, out UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_read_custom_widths_from_wdf More...
 
unsafe void SaveCgm (NXOpen.Tag drawing_sheet, ref JobOptions job_options, string job_name, ref BannerOptions banner_options, string cgm_file_name)
 Wrapper method for UF_PLOT_save_cgm More...
 
unsafe void SaveCgmForPlotLayout (string job_name, ref BannerOptions banner_options, string cgm_file_name)
 Wrapper method for UF_PLOT_save_cgm_for_plot_layout More...
 
unsafe void SetDrawingSheetColors (NXOpen.Tag drawing_sheet, ref UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_set_drawing_sheet_colors More...
 
unsafe void SetDrawingSheetWidths (NXOpen.Tag drawing_sheet, ref UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_set_drawing_sheet_widths More...
 
void SetPrinterGroup (string group_dir, string jobs_dir, string home_dir)
 Wrapper method for UF_PLOT_set_printer_group More...
 
unsafe void SetSessionBannerOptions (ref BannerOptions banner_options)
 Wrapper method for UF_PLOT_set_session_banner_options More...
 
unsafe void SetSessionCustomColors (ref UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_set_session_custom_colors More...
 
unsafe void SetSessionCustomWidths (ref UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_set_session_custom_widths More...
 
void SetSessionJobOptions (ref JobOptions job_options)
 Wrapper method for UF_PLOT_set_session_job_options More...
 
void SetUghpglSmallTol (double small_tolerance, int units)
 Wrapper method for UF_PLOT_set_ughpgl_small_tol More...
 
void SetUghpglTol (double shift_tolerance, int units)
 Wrapper method for UF_PLOT_set_ughpgl_tol More...
 
unsafe void WriteCustomColorsToCdf (string cdf_name, ref UFCgm.CustomColors custom_colors)
 Wrapper method for UF_PLOT_write_custom_colors_to_cdf More...
 
unsafe void WriteCustomWidthsToWdf (string wdf_name, ref UFCgm.CustomWidths custom_widths)
 Wrapper method for UF_PLOT_write_custom_widths_to_wdf 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...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

Contains wrappers for all 'UF_PLOT' functions and data types.

Member Enumeration Documentation

Wrapper for UF_PLOT_cmp_color_width_e

Refer to UF_PLOT_cmp_color_width_e for documentation

Wrapper for UF_PLOT_colors_e

Refer to UF_PLOT_colors_e for documentation

Wrapper for UF_PLOT_diff_cmp_status_e

Refer to UF_PLOT_diff_cmp_status_e for documentation

Wrapper for UF_PLOT_format_e

Refer to UF_PLOT_format_e for documentation

Wrapper for UF_PLOT_rotation_e

Refer to UF_PLOT_rotation_e for documentation

Wrapper for UF_PLOT_units_e

Refer to UF_PLOT_units_e for documentation

Wrapper for UF_PLOT_widths_e

Refer to UF_PLOT_widths_e for documentation

Member Function Documentation

void NXOpen.UF.UFPlot.AddJobToPlotLayout ( NXOpen.Tag  drawing_sheet,
ref JobOptions  job_options,
string  job_name,
Units  units,
double[]  origin,
Rotation  rotation,
double  scale,
out Extents  extents 
)
inline

Wrapper method for UF_PLOT_add_job_to_plot_layout

Refer to UF_PLOT_add_job_to_plot_layout for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDefaultBannerOptions ( out BannerOptions  banner_options)
inline

Wrapper method for UF_PLOT_ask_default_banner_options

Refer to UF_PLOT_ask_default_banner_options for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDefaultCustomColors ( out UFCgm.CustomColors  custom_colors)
inline

Wrapper method for UF_PLOT_ask_default_custom_colors

Refer to UF_PLOT_ask_default_custom_colors for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDefaultCustomWidths ( out UFCgm.CustomWidths  custom_widths)
inline

Wrapper method for UF_PLOT_ask_default_custom_widths

Refer to UF_PLOT_ask_default_custom_widths for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDefaultJobName ( NXOpen.Tag  drawing_sheet,
out string  job_name 
)
inline

Wrapper method for UF_PLOT_ask_default_job_name

Refer to UF_PLOT_ask_default_job_name for documentation

License requirements:None

void NXOpen.UF.UFPlot.AskDefaultJobOptions ( out JobOptions  job_options)
inline

Wrapper method for UF_PLOT_ask_default_job_options

Refer to UF_PLOT_ask_default_job_options for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDefaultPrinterAndProfile ( out string  printer,
out string  profile 
)
inline

Wrapper method for UF_PLOT_ask_default_printer_and_profile

Refer to UF_PLOT_ask_default_printer_and_profile for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDrawingSheetColors ( NXOpen.Tag  drawing_sheet,
out UFCgm.CustomColors  custom_colors 
)
inline

Wrapper method for UF_PLOT_ask_drawing_sheet_colors

Refer to UF_PLOT_ask_drawing_sheet_colors for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskDrawingSheetWidths ( NXOpen.Tag  drawing_sheet,
out UFCgm.CustomWidths  custom_widths 
)
inline

Wrapper method for UF_PLOT_ask_drawing_sheet_widths

Refer to UF_PLOT_ask_drawing_sheet_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.AskPlotLayoutExtents ( Units  units,
out Extents  extents 
)
inline

Wrapper method for UF_PLOT_ask_plot_layout_extents

Refer to UF_PLOT_ask_plot_layout_extents for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskPrinterGroups ( out int  num_printer_groups,
out PrinterGroup[]  printer_groups 
)
inline

Wrapper method for UF_PLOT_ask_printer_groups

Refer to UF_PLOT_ask_printer_groups for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskPrinterNames ( out int  num_printers,
out string[]  printers 
)
inline

Wrapper method for UF_PLOT_ask_printer_names

Refer to UF_PLOT_ask_printer_names for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskProfileNames ( string  printer,
out int  num_profiles,
out string[]  profiles 
)
inline

Wrapper method for UF_PLOT_ask_profile_names

Refer to UF_PLOT_ask_profile_names for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskSessionBannerOptions ( out BannerOptions  banner_options)
inline

Wrapper method for UF_PLOT_ask_session_banner_options

Refer to UF_PLOT_ask_session_banner_options for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskSessionCustomColors ( out UFCgm.CustomColors  custom_colors)
inline

Wrapper method for UF_PLOT_ask_session_custom_colors

Refer to UF_PLOT_ask_session_custom_colors for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.AskSessionCustomWidths ( out UFCgm.CustomWidths  custom_widths)
inline

Wrapper method for UF_PLOT_ask_session_custom_widths

Refer to UF_PLOT_ask_session_custom_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.AskSessionJobOptions ( out JobOptions  job_options)
inline

Wrapper method for UF_PLOT_ask_session_job_options

Refer to UF_PLOT_ask_session_job_options for documentation

License requirements:None

void NXOpen.UF.UFPlot.ClearPlotLayout ( )
inline

Wrapper method for UF_PLOT_clear_plot_layout

Refer to UF_PLOT_clear_plot_layout for documentation

License requirements:None

void NXOpen.UF.UFPlot.CompareUghpglFiles ( string  first_plot,
string  second_plot,
ref UghpglCmpOptions  compare_options,
string  result_plot,
out DiffCmpStatus  comparison_result 
)
inline

Wrapper method for UF_PLOT_compare_ughpgl_files

Refer to UF_PLOT_compare_ughpgl_files for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.ConvertCustomWidths ( Units  units,
ref UFCgm.CustomWidths  custom_widths 
)
inline

Wrapper method for UF_PLOT_convert_custom_widths

Refer to UF_PLOT_convert_custom_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.ConvertFile ( string  cgm_or_tiff_file_name,
Format  output_format,
string  output_file_name 
)
inline

Wrapper method for UF_PLOT_convert_file

Refer to UF_PLOT_convert_file for documentation

License requirements:None

void NXOpen.UF.UFPlot.DeleteDrawingSheetColors ( NXOpen.Tag  drawing_sheet)
inline

Wrapper method for UF_PLOT_delete_drawing_sheet_colors

Refer to UF_PLOT_delete_drawing_sheet_colors for documentation

License requirements:None

void NXOpen.UF.UFPlot.DeleteDrawingSheetWidths ( NXOpen.Tag  drawing_sheet)
inline

Wrapper method for UF_PLOT_delete_drawing_sheet_widths

Refer to UF_PLOT_delete_drawing_sheet_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.HasDrawingSheetColors ( NXOpen.Tag  drawing_sheet,
out bool  drawing_sheet_has_colors 
)
inline

Wrapper method for UF_PLOT_has_drawing_sheet_colors

Refer to UF_PLOT_has_drawing_sheet_colors for documentation

License requirements:None

void NXOpen.UF.UFPlot.HasDrawingSheetWidths ( NXOpen.Tag  drawing_sheet,
out bool  drawing_sheet_has_widths 
)
inline

Wrapper method for UF_PLOT_has_drawing_sheet_widths

Refer to UF_PLOT_has_drawing_sheet_widths for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.Print ( NXOpen.Tag  drawing_sheet,
ref JobOptions  job_options,
string  job_name,
ref BannerOptions  banner_options,
string  printer,
string  profile,
int  num_copies 
)
inline

Wrapper method for UF_PLOT_print

Refer to UF_PLOT_print for documentation

License requirements:None

void NXOpen.UF.UFPlot.PrintFile ( string  filename,
string  printer,
string  profile,
int  num_copies 
)
inline

Wrapper method for UF_PLOT_print_file

Refer to UF_PLOT_print_file for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.PrintPlotLayout ( string  job_name,
ref BannerOptions  banner_options,
string  printer,
string  profile,
int  num_copies 
)
inline

Wrapper method for UF_PLOT_print_plot_layout

Refer to UF_PLOT_print_plot_layout for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.ReadCustomColorsFromCdf ( string  cdf_name,
out UFCgm.CustomColors  custom_colors 
)
inline

Wrapper method for UF_PLOT_read_custom_colors_from_cdf

Refer to UF_PLOT_read_custom_colors_from_cdf for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.ReadCustomWidthsFromWdf ( string  wdf_name,
out UFCgm.CustomWidths  custom_widths 
)
inline

Wrapper method for UF_PLOT_read_custom_widths_from_wdf

Refer to UF_PLOT_read_custom_widths_from_wdf for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SaveCgm ( NXOpen.Tag  drawing_sheet,
ref JobOptions  job_options,
string  job_name,
ref BannerOptions  banner_options,
string  cgm_file_name 
)
inline

Wrapper method for UF_PLOT_save_cgm

Refer to UF_PLOT_save_cgm for documentation

In .NET "job_options" cannot be NULL, instead user has to initialize it by calling NXOpen.UF.UFPlot.AskSessionJobOptions

License requirements:None

unsafe void NXOpen.UF.UFPlot.SaveCgmForPlotLayout ( string  job_name,
ref BannerOptions  banner_options,
string  cgm_file_name 
)
inline

Wrapper method for UF_PLOT_save_cgm_for_plot_layout

Refer to UF_PLOT_save_cgm_for_plot_layout for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SetDrawingSheetColors ( NXOpen.Tag  drawing_sheet,
ref UFCgm.CustomColors  custom_colors 
)
inline

Wrapper method for UF_PLOT_set_drawing_sheet_colors

Refer to UF_PLOT_set_drawing_sheet_colors for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SetDrawingSheetWidths ( NXOpen.Tag  drawing_sheet,
ref UFCgm.CustomWidths  custom_widths 
)
inline

Wrapper method for UF_PLOT_set_drawing_sheet_widths

Refer to UF_PLOT_set_drawing_sheet_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.SetPrinterGroup ( string  group_dir,
string  jobs_dir,
string  home_dir 
)
inline

Wrapper method for UF_PLOT_set_printer_group

Refer to UF_PLOT_set_printer_group for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SetSessionBannerOptions ( ref BannerOptions  banner_options)
inline

Wrapper method for UF_PLOT_set_session_banner_options

Refer to UF_PLOT_set_session_banner_options for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SetSessionCustomColors ( ref UFCgm.CustomColors  custom_colors)
inline

Wrapper method for UF_PLOT_set_session_custom_colors

Refer to UF_PLOT_set_session_custom_colors for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.SetSessionCustomWidths ( ref UFCgm.CustomWidths  custom_widths)
inline

Wrapper method for UF_PLOT_set_session_custom_widths

Refer to UF_PLOT_set_session_custom_widths for documentation

License requirements:None

void NXOpen.UF.UFPlot.SetSessionJobOptions ( ref JobOptions  job_options)
inline

Wrapper method for UF_PLOT_set_session_job_options

Refer to UF_PLOT_set_session_job_options for documentation

License requirements:None

void NXOpen.UF.UFPlot.SetUghpglSmallTol ( double  small_tolerance,
int  units 
)
inline

Wrapper method for UF_PLOT_set_ughpgl_small_tol

Refer to UF_PLOT_set_ughpgl_small_tol for documentation

License requirements:None

void NXOpen.UF.UFPlot.SetUghpglTol ( double  shift_tolerance,
int  units 
)
inline

Wrapper method for UF_PLOT_set_ughpgl_tol

Refer to UF_PLOT_set_ughpgl_tol for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.WriteCustomColorsToCdf ( string  cdf_name,
ref UFCgm.CustomColors  custom_colors 
)
inline

Wrapper method for UF_PLOT_write_custom_colors_to_cdf

Refer to UF_PLOT_write_custom_colors_to_cdf for documentation

License requirements:None

unsafe void NXOpen.UF.UFPlot.WriteCustomWidthsToWdf ( string  wdf_name,
ref UFCgm.CustomWidths  custom_widths 
)
inline

Wrapper method for UF_PLOT_write_custom_widths_to_wdf

Refer to UF_PLOT_write_custom_widths_to_wdf for documentation

License requirements:None


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