Contents

About This Guide

Overview of the VB API

Introduction
Visual Basic.NET Applications
Visual Basic for Applications
Limitations of the VB API
Getting Started
Setting Up a VB Application
Object Types
Compact Data Classes
Unions
Sequences
Arrays
Enumeration Classes
Module-Level Classes
Action Listeners
Programming Considerations
Application Hierarchy
Optional Arguments and Tags
Optional Returns for the VB API Methods
Parent-Child Relationships between the VB API Objects
Run-Time Type Identification in the VB API
Support for Embedded OLE Objects
Exceptions

VB API Fundamentals:Controlling Creo Parametric

Overview
Simple Asynchronous Mode
Setting Up a Noninteractive Session
Example Code for Visual Basic.NET
Example Code for Visual Basic for Applications
Connecting Via Connection ID
Getting the Session Object
Full Asynchronous Mode
Example Code
Troubleshooting VB API Applications
General Problems

The VB API Online Browser

Online Documentation VB APIWizard
APIWizard Overview

Session Objects

Overview of Session Objects
Compatibility of Deprecated Methods
Directories
File Handling
Configuration Options
Macros
Colors and Line Styles
The Text Message File
Writing a Message Using a Message Pop-up Dialog Box
Accessing the Message Window
Message Classification
Displaying Feature Parameters
File Dialogs

Selection

Interactive Selection
Accessing Selection Data
Controlling Selection Display
Example Code: Using Interactive Selection
Programmatic Selection
Selection Buffer
Introduction to Selection Buffers
Reading the Contents of the Selection Buffer
Removing the Items of the Selection Buffer
Adding Items to the Selection Buffer

Ribbon Tabs, Groups, and Menu Items

Creating Ribbon Tabs, Groups, and Menu Items
Workflow to Add Menu Items to the Ribbon User Interface
About the Ribbon Definition File
To Specify the Path for the Ribbon Definition File
Loading Multiple Applications Using the Ribbon Definition File

Menus, Commands, and Pop-up Menus

Introduction
Menu Bar Definitions
Menus Buttons and Menus
Access Listeners for Commands
Bracket Listeners for Commands
Designating Commands
Command Icons
Designating the Command
Placing the Button
Pop-up Menus
Adding a Pop-up Menu to the Graphics Window
Using the Trail File to Determine Existing Pop-up Menu Names
Listening for Pop-up Menu Initialization
Accessing the Pop-up Menus
Adding Content to the Pop-up Menus
Example 3: Creating a Pop-up Menu

Models

Overview of Model Objects
Getting a Model Object
Model Descriptors
Retrieving Models
Example Code: Retrieving a Model
Model Information
Model Operations
Running Creo ModelCHECK
Custom Checks

Drawings

Overview of Drawings in the VB API
Creating Drawings from Templates
Drawing Creation Errors
Obtaining Drawing Models
Drawing Information
Drawing Operations
Example: Replace Drawing Model Solid with its Generic
Drawing Sheets
Drawing Sheet Information
Drawing Sheet Operations
Drawing Views
Creating Drawing Views
Obtaining Drawing Views
Drawing View Information
Drawing Views Operations
Drawing Dimensions
Obtaining Drawing Dimensions
Creating Drawing Dimensions
Drawing Dimensions Information
Drawing Dimensions Operations
Drawing Tables
Creating Drawing Cells
Selecting Drawing Tables and Cells
Creating Drawing Tables
Retrieving Drawing Tables
Drawing Tables Information
Drawing Tables Operations
Drawing Table Segments
Repeat Regions
Detail Items
Listing Detail Items
Creating a Detail Item
Detail Entities
Instructions
Detail Entities Information
Detail Entities Operations
OLE Objects
Detail Notes
Instructions
Detail Notes Information
Details Notes Operations
Detail Groups
Instructions
Detail Groups Information
Detail Groups Operations
Detail Symbols
Detail Symbol Definitions
Detail Symbol Instances
Detail Symbol Groups
Detail Attachments
Free Attachment
Parametric Attachment
Offset Attachment
Unsupported Attachment

Solid

Getting a Solid Object
Solid Information
Solid Operations
Solid Units
Types of Unit Systems
Accessing Individual Units
Modifying Individual Units
Creating a New Unit
Accessing Systems of Units
Modifying Systems of Units
Creating a New System of Units
Conversion to a New Unit System
Mass Properties
Example Code: Retrieving a Mass Property Object
Annotations
Cross Sections
Materials
Accessing Material Types
Accessing Material Properties
Accessing User-defined Material Properties

Solid Bodies

Solid Body Information

Windows and Views

Windows
Getting a Window Object
Window Operations
Embedded Browser
Views
Getting a View Object
View Operations
Coordinate Systems and Transformations
Coordinate Systems
Transformations

ModelItem

Solid Geometry Traversal
Getting ModelItem Objects
ModelItem Information
Duplicating ModelItems
Layer Objects
Getting Layer Objects
Layer Operations

Features

Access to Features
Feature Information
Feature Operations
Feature Groups and Patterns
Notes On Feature Groups
User Defined Features
Read Access to Groups and User Defined Features
Creating Features from UDFs
Creating UDFs
Creating Interactively Defined UDFs
Creating a Custom UDF

Datum Features

Datum Plane Features
Datum Axis Features
General Datum Point Features
Datum Coordinate System Features

Geometry Evaluation

Geometry Traversal
Geometry Terms
Traversing the Geometry of a Solid Block
Curves and Edges
The t Parameter
Curve and Edge Types
Evaluation of Curves and Edges
Solid Edge Geometry
Curve Descriptors
Contours
Surfaces
UV Parameterization
Surface Types
Surface Information
Evaluation of Surfaces
Surface Descriptors
Axes, Coordinate Systems, and Points
Evaluation of ModelItems
Interference
Analyzing Interference Information
Analyzing Interference Volume

Dimensions and Parameters

Overview
The ParamValue Object
Accessing a ParamValue Object
Accessing the ParamValue Value
Parameter Objects
Creating and Accessing Parameters
Parameter Selection Options
Parameter Information
Parameter Restrictions
Dimension Objects
Getting Dimensions
Dimension Information
Dimension Tolerances

Relations

Accessing Relations
Example 1: Adding Relations between Parameters in a Solid Model
Accessing Post Regeneration Relations
Relation Function Options
Relation Function Listeners
Example 2: Adding and Implementing a New Custom Relation Function

Assemblies and Components

Structure of Assemblies and Assembly Objects
Assembly Components
Regenerating an Assembly Component
Creating a Component Path
Component Path Information
Assembling Components
Constraint Attributes
Assembling a Component Parametrically
Redefining and Rerouting Assembly Components
Example: Component Constraints
Example: Assembling Components
Exploded Assemblies
Skeleton Models

Family Tables

Working with Family Tables
Accessing Instances
Accessing Columns
Accessing Cell Information
Creating Family Table Instances
Creating Family Table Columns
Example Code: Adding Dimensions to a Family Table

Action Listeners

The VB API Action Listeners
Action Sources
Types of Action Listeners
Session Level Action Listeners
UI Command Action Listeners
Model Level Action listeners
Solid Level Action Listeners
Selection Level Action Listeners
Feature Level Action Listeners
Cancelling an ActionListener Operation

Interface

Exporting Files and 2D Models
Export Instructions
Exporting Drawing Sheets
Exporting to Faceted Formats
Exporting Using Coordinate System
Exporting to PDF and U3D
Exporting 3D Geometry
Export Instructions
Export Utilities
Shrinkwrap Export
Setting Shrinkwrap Options
Surface Subset Options
Faceted Solid Options
Merged Solid Options
VRML Representation
Importing Files
Import Instructions
Importing 2D Models
Importing 3D Geometry
Modifying the Imported Layers
Plotting Files
Printing Files
Printer Options
Placement Options
Model Options
Plotter Configuration File (PCF) Options
Solid Operations
Example Code: Returning a Feature Object
Window Operations
Example Code: Generating Raster Files

Simplified Representations

Overview
Retrieving Simplified Representations
Creating and Deleting Simplified Representations
Extracting Information About Simplified Representations
Example 1: Working with Simplified Representation
Modifying Simplified Representations
Adding Items to and Deleting Items from a Simplified Representation
Simplified Representation Utilities

Task Based Application Libraries

Managing Application Arguments
Modifying Arguments
Launching a Creo TOOLKIT DLL
Launching Tasks from J-Link Task Libraries

Graphics

Overview
Getting Mouse Input
Drawing a Mouse Box
Displaying Graphics
Controlling Graphics Display
Example Code: Creating Graphics On Screen
Displaying Text in the Graphics Window
Controlling Text Fonts
Display Lists and Graphics
Exceptions
Example Code

External Data

External Data
Introduction to External Data
Compatibility with Creo TOOLKIT
Accessing External Data
Storing External Data
Initializing Data Objects
Retrieving External Data
Exceptions

Windchill Connectivity APIs

Introduction
Accessing Information Before Registering a Server
Registering and Activating a Server
Accessing Information From a Registered Server
Information on Servers in Session
Accessing Workspaces
Creating and Modifying the Workspace
Workflow to Register a Server
To Register a Server with an Existing Workspace
To Register a Server with a New Workspace
Aliased URL
Server Operations
Save
Upload
CheckIn
Retrieval
Checkout and Download
Undo Checkout
Import and Export
File Copy
Server Object Status
Delete Objects
Conflicts During Server Operations
Utility APIs
Sample Batch Workflow

Technical Summary of Changes for Creo 11.0.2.0

New Functions
Features
Full Version of CreoŽ Parametric VB API Release Notes

Sample Applications

Installing the VB API
Sample Applications
VBAPIExamples
Parameters and Dimensions

Geometry Traversal

Example 1
Example 2
Example 3
Example 4
Example 5

Geometry Representations

Surface Parameterization
Plane
Cylinder
Cone
Torus
General Surface of Revolution
Ruled Surface
Tabulated Cylinder
Coons Patch
Fillet Surface
Spline Surface
NURBS Surface
Cylindrical Spline Surface
Edge and Curve Parameterization
Line
Arc
Spline
NURBS
Copyright © 2024
Parametric Technology Corporation
140 Kendrick Street, Needham MA 02494 USA
All rights reserved