Examples

This section contains Python examples demonstrating the Impact API.

All Examples

• 3D model creation (Python)
• 3D model updating (Python)
• Activate block insertion and make changes (Python)
• Active Drawing Change (After) Auto-Task (Python)
• Active Drawing Change (Before) Auto-Task (Python)
• Active Layer Change (After) Auto-Task (Python)
• Active Layer Change (Before) Auto-Task (Python)
• Add Database Palettes (Python)
• Add Domain User (Python)
• Add User with Address (Python)
• Add, Change and Delete Table Rows for a custom TEST table (Python)
• Add, Change and Delete Table Rows linking ISite to multiple IUser objects (Python)
• Adding A Layer (Python)
• Adding Customers (Python)
• Adding Folders (Python)
• Adding Variables (Python)
• Adding a bridge (Python)
• Adding a bridge to a line (Python)
• Adding a user (Python)
• Adding multiple users (Python)
• Adding two 3D vectors (Python)
• Adding two vectors (Python)
• Advanced Corrugated Materials (Python)
• Advanced Release (Python)
• Advanced Standard Options (Python)
• Advanced Tags (Python)
• Advanced dialogs (Python)
• Application globals (Python)
• Applying a saved visibility (Python)
• Arc Centre (Python)
• Arc Clockwise (Python)
• Arc Length (Python)
• Arc Radius (Python)
• Arc Start Angle (Python)
• Arc Sweep Angle (Python)
• Arc example (Python)
• ArcA example (Python)
• ArcAd example (Python)
• ArcThreePointsA example (Python)
• ArcThreePointsAd example (Python)
• Arcd example (Python)
• Arrange Optional (Python)
• Arrange Optional 2 (Python)
• Assign Palette To Line (Python)
• Assigning one 3D vector to another (Python)
• Assigning one vector to another (Python)
• Associated Tags (Python)
• Asymmetrically scaling a line (Python)
• Auto Number Columns (Python)
• Auto Numbering (Python)
• AutoSelect example (Python)
• Automatic dimensioning (Python)
• Being Modified (Python)
• Bezier (Python)
• BezierA example (Python)
• BezierAd example (Python)
• Block and symbol visibility (Python)
• BlockInsert example (Python)
• BlockInsertA example (Python)
• BlockInsertAd example (Python)
• BlockInsertd example (Python)
• BlockType example (Python)
• Border Plot - Data Connection Arguments (Python)
• Border Plot Export to File (Python)
• Border Plot Page Numbering (Python)
• Border Plot directly (Python)
• Border Plot to specific printer (Python)
• Border plot a drawing revision (Python)
• Border plot a drawing without opening it (Python)
• Caculate distance between two vectors (Python)
• Calculate entity lengths within a text entity (Python)
• Calculate the distance between two 3D vectors (Python)
• Calculate the machine utilisation for a layout (Python)
• Change 3D Model Fold Ratio (Python)
• Change customer (Python)
• Change visibility of palette (Python)
• Changing Properties (Python)
• Changing appearance (Python)
• Changing layer visibility (Python)
• Changing the cursor (Python)
• Changing the palette of all selected entities (Python)
• Checking Active User (Python)
• Checking for Database Documents (Python)
• Checking for IML variables (Python)
• Checking if a block insert is active (Python)
• Circle example (Python)
• CircleA example (Python)
• CircleAd example (Python)
• CircleThreeTangents example (Python)
• Circled example (Python)
• Clearing Standard Information (Python)
• Compare two vectors (Python)
• Comparing two entities using the Is method (Python)
• Comparison of two 3D vectors (Python)
• Conversion example (Python)
• Conversion with unit settings (Python)
• Convert Angle To String (Python)
• Convert Length To String (Python)
• Convert a layer insert to a block insert (Python)
• Converting IML variables (Python)
• Converts a block insert to a layer insert (Python)
• Coordinate Systems (Python)
• Copy First 3D Instance (Python)
• Copy To Block (Python)
• CopyEntities example (Python)
• Copying Documents (Python)
• Copying a layer (Python)
• Copying entities (Python)
• Copying selected entities to another layer (Python)
• Count Items By Query (Python)
• Count and Find Items (Python)
• Count and Find Layers by Query (Python)
• Count and Find Layers by SQL (Python)
• Count and Find Layers by SQL Conditions (Python)
• Counting customers (Python)
• Counting items (Python)
• Create Rectangle (Python)
• Create Vector At Angle (Python)
• Creating Contact Documents (Python)
• Creating Customer Documents (Python)
• Creating Document Groups (Python)
• Creating Document History (Python)
• Creating Document Relationships (Python)
• Creating Documents (Python)
• Creating Documents from Streams (Python)
• Creating Items (Python)
• Creating Layer Documents (Python)
• Creating MIME Types (Python)
• Creating Other Documents (Python)
• Creating Project Documents (Python)
• Creating Relationships (Python)
• Creating Site Documents (Python)
• Creating Tags (Python)
• Creating User Documents (Python)
• Creating a common knife block in the active layer (Python)
• Creating a graphic entity (Python)
• Creating a graphic solid fill (Python)
• Creating a layer (Python)
• Creating a layout (Python)
• Creating a layout - the old method (Python)
• Creating a new block (Python)
• Creating a new layer (Python)
• Creating a new text style sheet based upon another (Python)
• Creating a new text style that is a copy of another (Python)
• Creating a project (Python)
• Creating a shape from a block insertion (Python)
• Creating a shape from a sequence of points (Python)
• Creating a shape from another shape with a transformation (Python)
• Creating a shape from visible regions (Python)
• Creating sausage shapes (Python)
• Creating text entities in every font (Python)
• Customer Info (Python)
• Customer Sites (Python)
• Customer Values (Python)
• Customer and Address Rowset (Python)
• Customer and Contact Addresses (Python)
• Database Info (Python)
• Database Item Translations (Python)
• Database Query (Python)
• Database globals (Python)
• Database values being read and written using lookup values (Python)
• Delete All 3D Instances (Python)
• Delete First 3D Instance (Python)
• DeleteSelected example (Python)
• Deleting All Document Groups (Python)
• Deleting All Tags (Python)
• Deleting Customers (Python)
• Deleting Folders (Python)
• Deleting IML variables (Python)
• Deleting Variables (Python)
• Deleting a MIME Type (Python)
• Deleting a palette (Python)
• Deleting a row from a table (Python)
• Deleting all MIME Types (Python)
• Deleting all the entities in the active block (Python)
• Describing all drawing text style sheets (Python)
• Describing all entity text style sheets (Python)
• Describing all fonts available to the system (Python)
• Describing all images in the drawing (Python)
• Describing all text entities in the drawing (Python)
• Describing all text style sheets (Python)
• Description example (Python)
• Detailed Item Info (Python)
• Determine If Entity Is Stale (Python)
• Determine certain calculated text values (Python)
• Determine if a shape encloses a point (Python)
• Determine if a shape encloses an entity (Python)
• Determining if a field with a given name exists (Python)
• Determining printer options (Python)
• Determining the active block (Python)
• DimensionAligned example (Python)
• DimensionAngle example (Python)
• DimensionBetweenPoints example (Python)
• DimensionHorizontal example (Python)
• DimensionRadius example (Python)
• DimensionVertical example (Python)
• Display Dialog (Python)
• Display Select Border Plot dialog (Python)
• Display Select Material (Python)
• Display Standard Wizard (Python)
• Display bridge information for entities (Python)
• Display layer attributes (Python)
• Display the Impact executable name and version (Python)
• Displaying Material Dialog (Python)
• Displaying the bridging information of a palette (Python)
• Displaying the display information of a palette (Python)
• Displaying the last plot operation (Python)
• Displaying the palette used for construction entities (Python)
• Displaying the palette used for dimension entities (Python)
• Displaying the palette used for text entities (Python)
• DistanceFormat (Python)
• Divide a 3D vector by a given value (Python)
• Divide a vector by a given value (Python)
• Document Change Values (Python)
• Document Counts (Python)
• Document Custom Columns (Python)
• Document Deleting (Python)
• Document Paging (Python)
• Document Provider (Python)
• Document Providers (Python)
• Document Relationships (Python)
• Document Search Criteria (Python)
• Document Searching (Python)
• Document Searching Criteria (Python)
• Document Settings (Python)
• Document UpdateFrom (Python)
• Document UpdateFromStream (Python)
• Document Used in Images (Python)
• Documents Paging (Python)
• Drawing Type Example (Python)
• Enquire Area (Python)
• Enquire Cut Lengths (Python)
• Enquire Individual Lengths of Cut palettes (Python)
• Enquire insertions (Python)
• Enquire using Palettes and PaletteTypes (Python)
• Enquire within all Symbols inserted into a Block (Python)
• Entities example (Python)
• Entity Advanced Properties (Python)
• Entity clipping and masking using shapes (Python)
• Examining and Updating Contacts (Python)
• Example (Python)
• Example Of AddBridge (Python)
• Example Of BoxContainsEntities (Python)
• Example Of Extend (Python)
• Example Of FindItemsBySQL For Folder (Python)
• Example Of GetFittedExtents (Python)
• Example Of GetKnifeToKnifeExtents (Python)
• Example Of OneUpArea (Python)
• Example Of SetActiveBlock (Python)
• Example Use Of Hatcher And Hatcher Options (Python)
• Example of FindDocumentByKey (Python)
• Example of FindItemsByQueryWithMax2 (Python)
• Example of FindItemsBySQL3 (Python)
• Example use of hole-finder object (Python)
• Example use of path-finder object (Python)
• ExecuteFile (Python)
• Executing multiple lines of SQL (Python)
• Exploding (Python)
• Exploding text entities (Python)
• Export Document Settings (Python)
• Export Item Specific Layers (Python)
• Export Specific Layers (Python)
• Export a database item (Python)
• Exporting a drawing (Python)
• Exporting all layers in a drawing (Python)
• Extending a line (Python)
• Extents example (Python)
• External Data Validation (Python)
• External Relationships (Python)
• Extract MetaData (Python)
• Extracting Meta-Data (Python)
• Extracting MetaData (Python)
• File Locations (Python)
• File Open dialog (Python)
• Fill Area (Python)
• Fillet example (Python)
• Filtering by Relationship (Python)
• Filtering by Relationships (Python)
• Find Document Types for extension (Python)
• Find Folders (Python)
• Find MIME Types for extensions (Python)
• Find layer referenced by border plot area (Python)
• Find user by email address (Python)
• Find user by key (Python)
• Find user by login id (Python)
• Find users by name (Python)
• Finding Columns (Python)
• Finding Folders (Python)
• Finding Groups by extensions (Python)
• Finding Groups for extensions (Python)
• Finding Items (Python)
• Finding MIME Types for extensions (Python)
• Finding Types for extensions (Python)
• Finding a master setting with a specific key (Python)
• Finding a post processor setting (Python)
• Finding customers (Python)
• Finding documents by ID (Python)
• Finding items (Python)
• Finding palettes (Python)
• Finding palettes by type (Python)
• Flatten 3D models (Python)
• Flip selected entities (Python)
• Fold 3D models (Python)
• Folder Finding (Python)
• Folder Info (Python)
• Folder Setting Properties (Python)
• Folder Translations (Python)
• FullName example (Python)
• Generate Default Thumbnails (Python)
• Generate Thumbnails (Python)
• Get Drawing Last Point (Python)
• Get Entity Extents (Python)
• Get Instance Extents (Python)
• Get Unreferenced Blocks (Python)
• Get drawing extents (Python)
• Get layout information (Python)
• Get length of entities example (Python)
• Get the names and primary keys of all customers (Python)
• Get translations for master tool setting folder names (Python)
• Get translations for master tool settings names (Python)
• GetAreaAndLengthOfSelected example (Python)
• GetEntityExtentsInBox example (Python)
• GetLengthOfEntitiesByPalette example (Python)
• GetPaletteExtents (Python)
• GetPaletteExtents example (Python)
• GetSelectedExtents example (Python)
• GetVisibleExtents example (Python)
• Getting and setting the stock sheet (Python)
• Getting the fitted extents of the active layer (Python)
• Getting the knife to knife extents of the active layer (Python)
• Getting the matrix of an insert (Python)
• Getting the rule length of used palettes in a layer (Python)
• Handling errors (Python)
• How to determine if the LDAP login ID has changed (Python)
• How to use a Database Query having a single distance range criterion (Python)
• Identity of a 3D Matrix (Python)
• Import Document Settings (Python)
• Import-Export Master Tool Settings (Python)
• Importing a drawing from a file (Python)
• Inserting a row into a table (Python)
• Inserting multiple rows into a table within transaction (Python)
• Insertion types (Python)
• Insertions example (Python)
• Inspecting Database and MTS Sites (Python)
• Inspecting MTS Filtered by Site (Python)
• Installed Licences (Python)
• Intersect Entity (Python)
• Inverse a 3D matrix (Python)
• Iterate Standard Sets (Python)
• Iterate Tables (Python)
• Iterating All Versions (Python)
• Iterating Document Columns and Values (Python)
• Iterating Document Groups (Python)
• Iterating Document History (Python)
• Iterating Document MetaExtractors (Python)
• Iterating Document Types (Python)
• Iterating Document for Items (Python)
• Iterating Documents (Python)
• Iterating Documents for Items (Python)
• Iterating History (Python)
• Iterating MIME Types (Python)
• Iterating Meta Extractors (Python)
• Iterating Pages and Areas (Python)
• Iterating Relationships (Python)
• Iterating Table Info (Python)
• Iterating Tags (Python)
• Iterating ThumbnailGenerators (Python)
• Iterating User Documents (Python)
• Iterating bridges (Python)
• LDAP Settings (Python)
• Layer example (Python)
• Layer revision properties (Python)
• Layer revisions (Python)
• Layer types (Python)
• LayerInsert example (Python)
• LayerInsertA example (Python)
• LayerInsertAd example (Python)
• LayerInsertd example (Python)
• Line example (Python)
• LineA example (Python)
• LineAd example (Python)
• LinePointTangent example (Python)
• LineTanTan example (Python)
• LineTangentPoint example (Python)
• Lined example (Python)
• Linked Values (Python)
• List 3D Model Layers (Python)
• Listing The Symbol In A Drawing (Python)
• Loading a Master Tool Setting (Python)
• Loading a jpeg image (Python)
• Loading a pdf image (Python)
• Loading a pdf image using automatic artwork alignment (Python)
• Loading an image from a document (Python)
• Lock 3D objects (Python)
• Lookup a Layer (Python)
• Lookup a layer value (Python)
• Manually assigning areas (Python)
• Matching the bridge style of an existing entity (Python)
• Merging PDF Documents (Python)
• Merging Tags (Python)
• Meta-Data Extraction (Python)
• Metric-Imperial Standard (Python)
• Mirror example (Python)
• MirrorAboutAxis (Python)
• Mirroring about axis (Python)
• Modify Start Point Of Line (Python)
• Modify dimension text attributes (Python)
• Modifying the palette used for construction entities (Python)
• Modifying the palette used for dimension entities (Python)
• Modifying the palette used for text entities (Python)
• Move example (Python)
• MoveA example (Python)
• MoveAd example (Python)
• Moved example (Python)
• Multiplies a vector by a given value (Python)
• Multiply a 3D matrix (Python)
• Multiply a 3D vector by a given value (Python)
• Negate the values of a 3D vector (Python)
• Negating the values of a vector (Python)
• NewLayer Auto-Task (Python)
• Offset a shape and create entities from it (Python)
• OffsetSelected example (Python)
• Open Enterprise project (Python)
• Opening Database Windows (Python)
• Opening Items (Python)
• Opening a connection for any registered database (Python)
• Opening a connection using a connection string (Python)
• Origin example (Python)
• Output a 3D matrix (Python)
• Parameter Along (Python)
• Pasting entities (Python)
• Performing a value mapping (Python)
• Persisted Globals - Reading (Python)
• Persisted Globals - Writing (Python)
• Picking a point from the active block (Python)
• Picking an entity and a point (Python)
• Picking an entity and its side from the active block (Python)
• Picking an entity in the active block (Python)
• Picking multiple points (Python)
• Picking using GetEntity2 (Python)
• Plotting (Python)
• Point On Side (Python)
• Printing all open drawings (Python)
• Printing all options (Python)
• Printing to default printer (Python)
• Printing to last used printer (Python)
• Printing with to specific printer (Python)
• Project And Layer Lookup (Python)
• Project Release Auto-Task (Python)
• Project Site (Python)
• Project and layer status (Python)
• Quick Mirror (Python)
• Reading Database Values (Python)
• Reading Layer Values (Python)
• Reading Related Table Values for ActiveDrawing (Python)
• Reading Related Table Values for IDatabaseItem (Python)
• Reading Related Table Values for IUser (Python)
• Reading Related Table Values for an Active Database Window (Python)
• Reading Simple Database Values (Python)
• Reading Table Rows (Advanced Data Types) for a custom TEST table (Python)
• Reading Table Rows (Advanced Data Types) for a custom TEST table (de-DE) (Python)
• Reading Table Rows for a custom TEST table (Python)
• Reading Values (Python)
• Reading and Writing Values (Python)
• Reading and writing binary values (Python)
• Reading master settings (Python)
• Reading master tool settings (Python)
• Reading rows from a table (Python)
• Reading rows from a table using string and BLOB lengths (Python)
• Reading rows from a table with parameters (Python)
• Reading-Writing Drawing Variables (Python)
• Reading-Writing Layer Variables (Python)
• Rebridge (Python)
• Rebridging (Python)
• Rebridging all entities in the active block (Python)
• Recalculate Variables (Python)
• Recalculating Variables (Python)
• Recursed entities (Python)
• Recursive Folder Info (Python)
• Removing a bridge (Python)
• Removing a common knife block from a layer in the active drawing (Python)
• Reverting Auto-Task (Python)
• Rotate example (Python)
• Rotate selected entities (Python)
• Rotating a 3D Matrix (Python)
• Rotating a vector (Python)
• Rubber Band Example (Python)
• Run a Standard (Python)
• Run a Standard in existing layer (Python)
• Running a border plot (Python)
• Running a query (Python)
• Running a query with sql (Python)
• Save Drawing As Image (Python)
• Save Layer As Image (Python)
• Save layer as image (Python)
• SaveAs Auto-Numbering (Python)
• SaveAs Related Table Values (Python)
• SaveAs with Auto-Numbering (Python)
• SaveToFile (Python)
• Saving Active Drawing (Python)
• Saving Projects (Python)
• Saving Projects2 (Python)
• Saving Symbols (Python)
• Saving Templates (Python)
• Saving a graphic entity (Python)
• Saving an image as a document (Python)
• Saving database values for a new project (Python)
• Saving thumbnails (Python)
• Scale a 3D Matrix (Python)
• Scaling a line (Python)
• Searching Documents (Python)
• Secondary Palette (Python)
• Select A Line (Python)
• Select a collection of entities (Python)
• SelectAll example (Python)
• SelectExpression example (Python)
• Selecting a line (Python)
• Selecting entities in the active block (Python)
• Selecting lines (Python)
• Selection example (Python)
• Sending Messages (Python)
• Series History (Python)
• Set 3D Instance Matrix (Python)
• Set 3D Instance Origin (Python)
• Setting the command (Python)
• Setting the snap mode when picking (Python)
• Shape Intersection (Python)
• Show system and version info (Python)
• ShowMessage Examples (Python)
• Simple 3D model creation (Python)
• Simple Dialog (Python)
• Simple Discard (Python)
• Simple Item Info (Python)
• Simple Pictures Example (Python)
• Simple Release (Python)
• Simple Update (Python)
• Simple dialog (Python)
• Simple dialog showing pulldown list (Python)
• Simple shape example (Python)
• Smoothing entities (Python)
• Specify Print Options for a Border Plot (Python)
• Split Line At Point (Python)
• Splitting Bezier at a point (Python)
• Splitting a bezier at its midpoint (Python)
• Splitting a line at its midpoint (Python)
• Splitting an arc at its midpoint (Python)
• Standard Creating (Python)
• Standard Set Info (Python)
• Standard Variables (Python)
• Starting a tool (Python)
• Starting the application and logging in (Python)
• Subtract one 3D vector from another (Python)
• Subtracting one vector from another (Python)
• Switching the direction of selected entities (Python)
• SymbolInsert example (Python)
• SymbolInsertA example (Python)
• SymbolInsertA2 example (Python)
• SymbolInsertAd example (Python)
• SymbolInsertAd2 example (Python)
• SymbolInsertd example (Python)
• Table Active or Archive Info (Python)
• Table GUID Column Info (Python)
• Table Modification Info (Python)
• Table Relationship Options (Python)
• Table Relationships (Python)
• Table Remote Info (Python)
• TextA example (Python)
• TextA2 example (Python)
• TextAd example (Python)
• Thumbnail Generation (Python)
• Tidy Gaps Example (Python)
• Tidy Slots (Python)
• Total Cut Lengths specifying EntityTypes (Python)
• Transform a 3D instance (Python)
• Transform the selected 3D instances (Python)
• Transforming a vector (Python)
• Transforming an entity (Python)
• Translate a 3D matrix (Python)
• Translate example (Python)
• TrimCorner example (Python)
• TrimIntersect example (Python)
• Uniting multiple shapes (Python)
• Update Domain Users (Python)
• Update Various Items (Python)
• Updating Customers (Python)
• Updating Database Palettes (Python)
• Updating Document Groups (Python)
• Updating Documents (Python)
• Updating Dynamic Text (Python)
• Updating MIME Type MaxFileSizeMB (Python)
• Updating MIME Type MetaExtractor (Python)
• Updating MIME Type ThumbnailGenerator (Python)
• Updating MIME Types (Python)
• Updating MIME Types MaxFileSizeMB (Python)
• Updating MIME Types MetaExtractor and ThumbnailGenerator (Python)
• Updating Project values from IDatabaseItem (Python)
• Updating Tags (Python)
• Updating Various Items (Python)
• Updating a row in a table (Python)
• Updating and reading binary data (Python)
• Updating mulitple rows in a table (Python)
• Use of Dimension Options (Python)
• User Info (Python)
• Users Domain Account Statuses (Python)
• Users Domain Info (Python)
• Users Info (Python)
• Using CountLayers and FindLayers with SQLfilterConditions (Python)
• Using Drag2 to reposition entities (Python)
• Using IDocumentCreator (Python)
• Using IDocumentCreator for Unsaved Projects (Python)
• Using PathFinder (Python)
• Using SymbolInsertA to replace symbols (Python)
• Using hole finder with blocks (Python)
• Using recursed entities to count symbols (Python)
• Using the IDocumentCreator Advanced (Python)
• Using the IDocumentCreator Simple (Python)
• Using the hole finder (Python)
• Various Border Plot Area Properties (Python)
• Various Layer Properties (Python)
• Various block enquiries (Python)
• Various shape properties (Python)
• ViewBox (Python)
• ViewSettings example (Python)
• Working Documents (Python)
• Working Projects (Python)
• Writing Database Values (Python)
• Writing Layer Values (Python)
• Writing Multiple Table Rows (Advanced Data Types) for a custom TEST table (Python)
• Writing Multiple Table Rows (Advanced Data Types) for a custom TEST table (de-DE) (Python)
• Writing Special Values (Python)
• Writing Values (Python)
• Writing to the debug log (Python)