Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Impact Python COM documentation
Impact Python COM documentation
  • Introduction
    • Welcome
    • Getting Started With Scripts
    • Impact Objects
    • What’s New
  • Concepts
    • Built-In Objects
    • Impact Auto-Tasks
    • Impact Enumerations
    • Scripts Within Database Windows
    • Impact Plug-ins
    • Specifying Colours
  • Libraries
    • Impact
      • Application
      • IApplication
      • IDatabaseWindow
      • IDatabaseWindowOptions
      • IDialog
      • IDialogCallbackParams
      • IDialogField
      • IDialogFields
      • IDialogPictureOptions
      • IFileOpenDialog
      • IFileSaveDialog
      • IGUI
      • IOutputToolbox
      • IPickInfo
      • IPicker
      • IPlotContext
      • ITools
      • ImpactCOMIterator
      • ImpactCOMWrapperBase
    • ImpactCAD
      • I3DCamera
      • I3DCreateModelFlags
      • I3DCreateModelOptions
      • I3DCreator
      • I3DInstance
      • I3DInstances
      • I3DMatrix
      • I3DModel
      • I3DObject
      • I3DRect
      • I3DScene
      • I3DUpdateModelOptions
      • I3DVector
      • IActiveBlock
      • IAddress
      • IAddresses
      • IAdvancedQueryPlugin
      • IAngleDimension
      • IAnnotationDimension
      • IArc
      • IAutoNumberColumn
      • IBezier
      • IBlock
      • IBlockInsert
      • IBlockInserts
      • IBlocks
      • IBorderPlotArea
      • IBorderPlotCreator
      • IBorderPlotPage
      • IBorderPlotPageArea
      • IBorderPlotPageAreas
      • IBorderPlotPageDataRepeater
      • IBorderPlotPageDataRepeaters
      • IBorderPlotPages
      • IBridge
      • IBridgeStyle
      • IBridgeStyles
      • IBridges
      • ICaseCompressionPlugin
      • ICentreDimension
      • ICommonKnifeOptions
      • IConvertor
      • ICoordinateSystem
      • ICorrugatedMaterial
      • ICorrugatedMaterialComponent
      • ICorrugatedMaterialComponents
      • ICorrugatedMaterialInfoRow
      • ICorrugatedMaterialInfoRows
      • ICountItemsOptions
      • ICreator
      • ICustomer
      • ICustomerContact
      • ICustomerContacts
      • ICustomerSites
      • ICustomers
      • IDataConnector
      • IDatabase
      • IDatabaseColumn
      • IDatabaseColumnValue
      • IDatabaseColumns
      • IDatabaseCommand
      • IDatabaseConnection
      • IDatabaseDriver
      • IDatabaseItem
      • IDatabaseItems
      • IDatabaseLayer
      • IDatabaseLayerRevision
      • IDatabaseLayerRevisions
      • IDatabaseLayers
      • IDatabaseParameterValue
      • IDatabaseQuery
      • IDatabaseQueryMasterSetting
      • IDatabaseQueryMasterSettingCriteria
      • IDatabaseQueryMasterSettingCriterion
      • IDatabaseReportItem
      • IDatabaseReportItems
      • IDatabaseReportParams
      • IDatabaseRevision
      • IDatabaseRevisions
      • IDatabaseServer
      • IDatabaseSettings
      • IDatabaseTable
      • IDatabaseTableRelationship
      • IDatabaseTableRelationshipOptions
      • IDatabaseTableRelationships
      • IDatabaseTableRow
      • IDatabaseTableRows
      • IDatabaseTableValues
      • IDatabaseTables
      • IDatabaseValues
      • IDatabases
      • IDimension
      • IDimensionAngleFormat
      • IDimensionDistanceFormat
      • IDimensionOptions
      • IDocument
      • IDocumentColumn
      • IDocumentColumns
      • IDocumentContext
      • IDocumentCreator
      • IDocumentCreatorDocument
      • IDocumentCreatorRelationship
      • IDocumentCriterion
      • IDocumentExtender
      • IDocumentGroup
      • IDocumentGroups
      • IDocumentHistory
      • IDocumentHistoryItem
      • IDocumentMIMEType
      • IDocumentMIMETypes
      • IDocumentMetaExtractor
      • IDocumentMetaExtractors
      • IDocumentProvider
      • IDocumentRelationship
      • IDocumentRelationships
      • IDocumentRowsetOptions
      • IDocumentSearch
      • IDocumentSettings
      • IDocumentTag
      • IDocumentTags
      • IDocumentTagsForDocument
      • IDocumentThumbnailGenerator
      • IDocumentThumbnailGenerators
      • IDocumentType
      • IDocumentTypes
      • IDocuments
      • IDocumentsRelationship
      • IDragParams
      • IDrawing
      • IDrawingSaveOptions
      • IDrawingVariableSettings
      • IDrawings
      • IEnquireArea
      • IEnquireInsertion
      • IEnquireInsertions
      • IEnquireLengths
      • IEntities
      • IEntity
      • IErrorItem
      • IErrorItems
      • IExplodeOptions
      • IExportLayers
      • IExportOptions
      • IFileFormats
      • IFindItemsOptions
      • IFoldData
      • IFolder
      • IFolders
      • IFont
      • IFonts
      • IGlobal
      • IGlobals
      • IGraphic
      • IGraphicFace
      • IGraphicImage
      • IGraphicImages
      • IGraphicOptions
      • IHatchOptions
      • IHatcher
      • IHoleFinder
      • IHolePathOptions
      • IImageFormatParams
      • IImportExportMasterSetting
      • IInsertEntity
      • ILDAPSettings
      • ILDAPUserAccountStatus
      • ILanguage
      • ILanguages
      • ILayer
      • ILayerInsert
      • ILayers
      • ILayoutOptions
      • ILayoutResults
      • ILeaderDimension
      • ILibraryObject
      • ILibraryObjects
      • ILicence
      • ILine
      • ILinearDimension
      • ILog
      • ILookup
      • ILookupParameters
      • ILookupProjectAndLayerKeysFromValueParams
      • ILookups
      • IMasterLayerInsert
      • IMasterSetting
      • IMasterSettings
      • IMasterToolSettingsFolderTranslationsParams
      • IMatrix
      • IPDFUtilities
      • IPalette
      • IPaletteBridgeInfo
      • IPaletteDisplayInfo
      • IPaletteGroup
      • IPaletteGroups
      • IPaletteOptions
      • IPalettes
      • IPathFinder
      • IPlotOptions
      • IPostScriptImageOptions
      • IPrintOptions
      • IProjectAndLayerFilterOptions
      • IRadiusDimension
      • IRebridgeOptions
      • IRect
      • IRecursedEntities
      • IRecursedEntity
      • IReleaseAction
      • IReleaseLayer
      • IReleaseLayers
      • IRevertAction
      • IRowCountOptions
      • IRowsetOptions
      • IRubberEntity
      • ISQLFilterCondition
      • ISaveImageParams
      • IServer
      • IServerLicence
      • IServerLicenceUser
      • IServerLicenceUsers
      • IServerLicences
      • IShape
      • IShapeCreator
      • IShapes
      • ISite
      • ISites
      • ISmoothOptions
      • IStandardCreator
      • IStandardMaterialMasterSetting
      • IStandardSet
      • IStandardSets
      • IStandardSettings
      • ISweepDimension
      • ISymbol
      • ISymbolInsert
      • ISymbols
      • ISystem
      • IText
      • ITextPlugin
      • ITextPlugin2
      • ITextStyle
      • ITextStyleSheet
      • ITextStyleSheets
      • IUnitSettings
      • IUnits
      • IUser
      • IUsers
      • IVariable
      • IVariableGroup
      • IVariableGroups
      • IVariables
      • IVector
      • IVersion
      • IViewSettings
      • IWindow
      • IWindows
      • ImpactCOMIterator
      • ImpactCOMWrapperBase
      • Server
    • ImpactBrowser
      • Browser
      • IBrowser
      • ImpactCOMIterator
      • ImpactCOMWrapperBase
  • Examples
    • Impact
      • Application
        • Application globals
        • Display the Impact executable name and version
        • Starting the application and logging in
      • IDatabaseWindow
        • Reading and Writing Values
        • Displaying Material Dialog
        • External Data Validation
        • Reading and Writing Values
      • IDatabaseWindowOptions
        • Display Select Material
        • External Data Validation
        • Reading and Writing Values
      • IDialog
        • Advanced dialogs
        • Simple Dialog
        • Advanced dialogs
        • Simple dialog
        • Simple dialog showing pulldown list
        • Simple Pictures Example
      • IDialogCallbackParams
        • Advanced dialogs
      • IDialogField
        • Advanced dialogs
        • Simple Dialog
      • IDialogFields
        • Simple dialog showing pulldown list
        • Simple Pictures Example
        • Advanced dialogs
        • Simple Dialog
      • IFileOpenDialog
        • File Open dialog
      • IGUI
        • Reverting Auto-Task
        • Changing appearance
        • File Open dialog
        • Changing the cursor
        • Using Drag2 to reposition entities
        • Running a query
        • Running a query with sql
        • Opening Database Windows
        • Opening Database Windows
        • Open Enterprise project
        • Performing a value mapping
        • Running a border plot
        • ShowMessage Examples
      • IPicker
        • Picking an entity in the active block
        • Picking using GetEntity2
        • Picking an entity and a point
        • Picking multiple points
        • Picking an entity and its side from the active block
        • Picking a point from the active block
        • Setting the snap mode when picking
        • Rubber Band Example
        • Selecting entities in the active block
        • Setting the snap mode when picking
        • Picking multiple points
      • IPlotContext
        • Displaying the last plot operation
      • ITools
        • Displaying the last plot operation
        • Creating a layer
        • Creating a project
        • ExecuteFile
        • Fill Area
        • Using hole finder with blocks
        • Using the hole finder
        • Creating a layout - the old method
        • Using PathFinder
        • Plotting
        • Starting a tool
    • ImpactBrowser
      • IBrowser
        • Displaying Items
    • ImpactCAD
      • I3DCreator
        • 3D model creation
        • Simple 3D model creation
        • 3D model updating
      • I3DInstance
        • Copy First 3D Instance
        • Delete First 3D Instance
        • Get Instance Extents
        • Lock 3D objects
        • Set 3D Instance Matrix
        • Set 3D Instance Origin
        • Transform a 3D instance
      • I3DInstances
        • 3D model creation
        • Simple 3D model creation
        • Delete All 3D Instances
      • I3DMatrix
        • Identity of a 3D Matrix
        • Inverse a 3D matrix
        • Multiply a 3D matrix
        • Rotating a 3D Matrix
        • Scale a 3D Matrix
        • Output a 3D matrix
        • Translate a 3D matrix
      • I3DModel
        • 3D model updating
        • Flatten 3D models
        • Fold 3D models
        • Change 3D Model Fold Ratio
        • List 3D Model Layers
        • Example
      • I3DScene
        • Transform the selected 3D instances
      • I3DVector
        • Adding two 3D vectors
        • Assigning one 3D vector to another
        • Calculate the distance between two 3D vectors
        • Divide a 3D vector by a given value
        • Comparison of two 3D vectors
        • Multiply a 3D vector by a given value
        • Negate the values of a 3D vector
        • Subtract one 3D vector from another
      • IActiveBlock
        • Determining the active block
        • Arc example
        • ArcA example
        • ArcAd example
        • ArcThreePointsA example
        • ArcThreePointsAd example
        • Arcd example
        • Arrange Optional
        • Arrange Optional 2
        • AutoSelect example
        • BezierA example
        • BezierAd example
        • Creating a new block
        • BlockInsert example
        • BlockInsertA example
        • BlockInsertAd example
        • BlockInsertd example
        • Changing the palette of all selected entities
        • Changing the palette of all selected entities
        • Circle example
        • CircleA example
        • CircleAd example
        • CircleThreeTangents example
        • Circled example
        • CopyEntities example
        • Copying selected entities to another layer
        • DeleteSelected example
        • DimensionAligned example
        • DimensionAngle example
        • Automatic dimensioning
        • DimensionBetweenPoints example
        • DimensionHorizontal example
        • DimensionRadius example
        • DimensionVertical example
        • Exploding text entities
        • Fillet example
        • GetAreaAndLengthOfSelected example
        • GetEntityExtentsInBox example
        • GetLengthOfEntitiesByPalette example
        • GetPaletteExtents
        • GetSelectedExtents example
        • GetVisibleExtents example
        • Creating a graphic entity
        • Creating a graphic solid fill
        • Creating a graphic entity
        • Creating a graphic solid fill
        • Creating a graphic entity
        • Creating a graphic solid fill
        • Creating a graphic entity
        • Creating a graphic solid fill
        • LayerInsert example
        • LayerInsertA example
        • LayerInsertAd example
        • LayerInsertd example
        • Line example
        • LineA example
        • LineAd example
        • LinePointTangent example
        • LineTanTan example
        • LineTangentPoint example
        • Lined example
        • Flip selected entities
        • Mirror example
        • Quick Mirror
        • Move example
        • MoveA example
        • MoveAd example
        • Moved example
        • OffsetSelected example
        • Origin example
        • Pasting entities
        • Matching the bridge style of an existing entity
        • Rebridge
        • Rebridging all entities in the active block
        • Rotate example
        • Rotate selected entities
        • Scaling a line
        • Asymmetrically scaling a line
        • Asymmetrically scaling a line
        • Scaling a line
        • Select a collection of entities
        • SelectAll example
        • Selecting lines
        • Selecting lines
        • Selecting a line
        • Selecting a line
        • SelectExpression example
        • Selecting lines
        • Selecting lines
        • Selection example
        • Smoothing entities
        • Switching the direction of selected entities
        • Switching the ‘sides’ of entities
        • SymbolInsert example
        • SymbolInsertA example
        • Using SymbolInsertA to replace symbols
        • SymbolInsertA2 example
        • SymbolInsertAd example
        • SymbolInsertAd2 example
        • SymbolInsertd example
        • TextA example
        • TextA2 example
        • Creating text entities in every font
        • TextAd example
        • TextAd example
        • Tidy Gaps Example
        • Tidy Slots
        • Translate example
        • TrimCorner example
        • TrimIntersect example
      • IAddress
        • User Info
      • IAddresses
        • Add User with Address
      • IArc
        • Arc Centre
        • Arc Clockwise
        • Display palette text
        • Arc Length
        • Parameter Along
        • Arc Radius
        • Splitting an arc at its midpoint
        • Arc Start Angle
        • Arc Sweep Angle
        • Entity Advanced Properties
      • IAutoNumberColumn
        • Auto Number Columns
      • IBezier
        • Bezier Control 1
        • Bezier Control 2
        • Bezier Control 3
        • Bezier Control 4
        • Display palette text
        • Parameter Along
        • Splitting a bezier at its midpoint
        • Splitting Bezier at a point
        • Bezier
      • IBlock
        • Determining the active block
        • BlockType example
        • Description example
        • Entities example
        • Extents example
        • FullName example
        • Get length of entities example
        • Getting the rule length of used palettes in a layer
        • Various block enquiries
        • GetPaletteExtents example
        • Insertions example
        • Layer example
        • Recursed entities
        • Using recursed entities to count symbols
        • Block and symbol visibility
      • IBlockInsert
        • Activate block insertion and make changes
        • Checking if a block insert is active
      • IBorderPlotArea
        • Various Border Plot Area Properties
      • IBorderPlotCreator
        • Border plot a drawing revision
        • Border plot a drawing without opening it
        • Border Plot directly
        • Border Plot Export to File
        • Border Plot Page Numbering
        • Border Plot to specific printer
        • Display Select Border Plot dialog
        • Iterating Pages and Areas
        • Manually assigning areas
        • Specify Print Options for a Border Plot
      • IBorderPlotPageArea
        • Manually assigning areas
      • IBorderPlotPageAreas
        • Iterating Pages and Areas
      • IBorderPlotPageDataRepeaters
        • Border Plot - Data Connection Arguments
      • IBorderPlotPages
        • Iterating Pages and Areas
      • IBridge
        • Iterating bridges
        • Iterating bridges
        • Iterating bridges
        • Iterating bridges
        • Iterating bridges
        • Iterating bridges
      • IBridges
        • Adding a bridge
        • Removing a bridge
        • Display bridge information for entities
      • IConvertor
        • Convert Angle To String
        • Convert Length To String
        • Conversion with unit settings
        • Conversion example
        • Conversion with unit settings
      • ICorrugatedMaterial
        • Advanced Corrugated Materials
      • ICreator
        • Smoothing entities
        • Exploding
        • Saving a graphic entity
        • Plotting
        • Loading a pdf image
        • Rebridging all entities in the active block
        • Create Rectangle
        • Smoothing entities
        • Create Vector At Angle
      • ICustomer
        • Customer and Contact Addresses
        • Deleting Customers
        • Creating Customer Documents
        • Customer Values
        • Adding Customers
        • Customer Info
        • Customer Values
        • Updating Customers
      • ICustomerContact
        • Customer and Contact Addresses
        • Creating Contact Documents
        • Examining and Updating Contacts
      • ICustomerSites
        • Customer Sites
      • ICustomers
        • Adding Customers
        • Counting customers
        • Finding a customer with a specific key.
        • Finding customers
      • IDataConnector
        • Border Plot - Data Connection Arguments
      • IDatabase
        • Active Drawing Change (After) Auto-Task
        • Active Drawing Change (Before) Auto-Task
        • Active Layer Change (After) Auto-Task
        • Active Layer Change (Before) Auto-Task
        • Update Domain Users
        • Count and Find Items
        • How to use a Database Query having a single distance range criterion
        • Count Items By Query
        • Counting items
        • Count and Find Layers by Query
        • Count and Find Layers by SQL
        • Count and Find Layers by SQL Conditions
        • Creating Items
        • Documents Paging
        • Document Searching
        • External Relationships
        • Handling errors
        • Finding documents by ID
        • Example of FindDocumentByKey
        • Finding a document with a specific key
        • Finding Items
        • Count and Find Items
        • How to use a Database Query having a single distance range criterion
        • Finding items
        • Example of FindItemsByQueryWithMax2
        • Finding Items Using SQL (VB.NET)
        • Example of FindItemsBySQL3
        • Count and Find Layers by Query
        • Count and Find Layers by SQL
        • Count and Find Layers by SQL Conditions
        • Exporting a drawing
        • Finding a post processor setting
        • Finding a master setting with a specific key
        • Reading master tool settings
        • Customer and Address Rowset
        • Find user by email address
        • Auto Numbering
        • Get the names and primary keys of all customers
        • Database globals
        • Importing a drawing from a file
        • How to determine if the LDAP login ID has changed
        • LDAP Settings
        • Lookup a Layer
        • Project And Layer Lookup
        • Lookup a layer value
        • Project And Layer Lookup
        • Get translations for master tool settings names
        • Get translations for master tool settings names
        • Get translations for master tool setting folder names
        • Inspecting Database and MTS Sites
        • Working Documents
        • Creating Items
        • Database Info
        • Finding Items
        • Iterating Table Info
      • IDatabaseColumnValue
        • Updating and reading binary data
      • IDatabaseCommand
        • Deleting a row from a table
        • Inserting a row into a table
        • Inserting multiple rows into a table within transaction
        • Updating a row in a table
        • Updating mulitple rows in a table
      • IDatabaseConnection
        • Inserting multiple rows into a table within transaction
        • Opening a connection for any registered database
        • Opening a connection using a connection string
        • Execute multiple lines of SQL
        • Inserting a row into a table
        • Deleting a row from a table
        • Executing multiple lines of SQL
        • Inserting a row into a table
        • Inserting multiple rows into a table within transaction
        • Opening a connection for any registered database
        • Opening a connection using a connection string
        • Reading rows from a table
        • Reading rows from a table using string and BLOB lengths
        • Reading rows from a table with parameters
        • Updating a row in a table
        • Updating and reading binary data
        • Updating mulitple rows in a table
      • IDatabaseItem
        • Iterating Document for Items
        • Being Modified
        • Change customer
        • Advanced Release
        • Simple Discard
        • Simple Release
        • Simple Update
        • Database Item Translations
        • Creating Project Documents
        • Iterating Documents for Items
        • Export a database item
        • Export Item Specific Layers
        • File Locations
        • Opening Items
        • Database Item Translations
        • Saving thumbnails
        • Project Site
        • Reading Values
        • Writing Values
        • File Locations
        • Advanced Release
        • Detailed Item Info
        • Opening Items
        • Reading Database Values
        • Simple Discard
        • Simple Item Info
        • Simple Release
        • Simple Update
        • Writing Database Values
      • IDatabaseLayer
        • Creating Layer Documents
        • Saving thumbnails
        • Reading Layer Values
        • Writing Layer Values
        • File Locations
        • Reading Layer Values
        • Writing Layer Values
      • IDatabaseLayerRevision
        • Layer revision properties
      • IDatabaseLayerRevisions
        • Layer revisions
      • IDatabaseQuery
        • Reading rows from a table
        • Reading rows from a table using string and BLOB lengths
        • Reading rows from a table with parameters
      • IDatabaseQueryMasterSetting
        • Database Query
      • IDatabaseRevision
        • File Locations
      • IDatabaseSettings
        • Checking for Database Documents
        • Inspecting Database and MTS Sites
        • Document Provider
        • Document Settings
        • Checking for Database Documents
        • Inspecting Database and MTS Sites
        • Checking for Database Documents
        • Persisted Globals - Reading
        • Persisted Globals - Writing
        • Checking for Database Documents
        • Checking for Database Documents
        • Checking for Database Documents
        • Checking for Database Documents
        • Document Settings
        • Inspecting Database and MTS Sites
      • IDatabaseTable
        • Table GUID Column Info
        • Table Active or Archive Info
        • Table Modification Info
        • Table Remote Info
      • IDatabaseTableRelationshipOptions
        • Table Relationship Options
      • IDatabaseTableRelationships
        • Table Relationships
      • IDatabaseTables
        • Iterate Tables
      • IDatabaseValues
        • Updating Project values from IDatabaseItem
        • Determining if a field with a given name exists
        • Reading Simple Database Values
        • Reading Related Table Values for ActiveDrawing
        • Reading Related Table Values for an Active Database Window
        • Reading Related Table Values for IDatabaseItem
        • Reading Related Table Values for IUser
        • SaveAs Related Table Values
        • Add, Change and Delete Table Rows for a custom TEST table
        • Add, Change and Delete Table Rows linking ISite to multiple IUser objects
        • Database values being read and written using lookup values
        • Determining if a field with a given name exists
        • Linked Values
        • Reading and writing binary values
        • Reading Related Table Values for ActiveDrawing
        • Reading Related Table Values for an Active Database Window
        • Reading Related Table Values for IDatabaseItem
        • Reading Related Table Values for IUser
        • Reading Simple Database Values
        • Reading Table Rows (Advanced Data Types) for a custom TEST table
        • Reading Table Rows (Advanced Data Types) for a custom TEST table (de-DE)
        • Reading Table Rows for a custom TEST table
        • Saving database values for a new project
        • Updating Project values from IDatabaseItem
        • Writing Multiple Table Rows (Advanced Data Types) for a custom TEST table
        • Writing Multiple Table Rows (Advanced Data Types) for a custom TEST table (de-DE)
      • IDimension
        • Modify dimension text attributes
      • IDimensionOptions
        • Use of Dimension Options
      • IDocument
        • Checking Active User
        • Iterating All Versions
        • Changing Properties
        • Document UpdateFrom
        • Changing Properties
        • Copying Documents
        • Document Deleting
        • Document Change Values
        • Creating Document History
        • Iterating Document History
        • Document Deleting
        • Creating Document Relationships
        • Series History
        • Iterating Relationships
        • Document Deleting
        • Document Deleting
        • Document UpdateFrom
        • Document UpdateFromStream
        • Document Used in Images
        • Document Custom Columns
        • Iterating Document Columns and Values
        • Changing Properties
        • Checking Active User
        • Copying Documents
        • Updating Documents
      • IDocumentColumn
        • Finding Columns
        • Iterating Document Types
      • IDocumentColumns
        • Finding Columns
        • Iterating Document Types
      • IDocumentContext
        • Document Paging
        • Document Searching
      • IDocumentCreator
        • Displaying ‘Add Documents’
        • Displaying ‘Add Documents’
        • Using IDocumentCreator
      • IDocumentCriterion
        • Document Searching Criteria
      • IDocumentExtender
        • Document Providers
      • IDocumentGroup
        • Finding Groups by extensions
        • Creating Documents
        • Searching Documents
        • Updating Document Groups
      • IDocumentGroups
        • Creating Document Groups
        • Finding Groups for extensions
        • Finding Groups for extensions
        • Creating Document Groups
        • Deleting All Document Groups
        • Finding Groups for extensions
        • Iterating Document Groups
      • IDocumentHistory
        • Iterating Document History
      • IDocumentMIMEType
        • Updating MIME Type MaxFileSizeMB
        • Extracting Meta-Data
        • Updating MIME Type MetaExtractor
        • Generate Thumbnails
        • Updating MIME Type ThumbnailGenerator
        • Creating MIME Types
        • Deleting a MIME Type
        • Deleting all MIME Types
        • Generate Default Thumbnails
        • Generate Thumbnails
        • Iterating MIME Types
        • Updating MIME Types
      • IDocumentMIMETypes
        • Creating MIME Types
        • Find MIME Types for extensions
        • Find Document Types for extension
        • Creating MIME Types
        • Finding MIME Types for extensions
        • Iterating MIME Types
        • Updating MIME Types MaxFileSizeMB
        • Updating MIME Types MetaExtractor and ThumbnailGenerator
      • IDocumentMetaExtractor
        • Extract MetaData
        • Iterating Meta Extractors
        • Extracting MetaData
      • IDocumentMetaExtractors
        • Extracting MetaData
        • Iterating Document MetaExtractors
      • IDocumentProvider
        • Document Counts
        • Document Counts
        • Document Provider
      • IDocumentRelationship
        • Creating Relationships
      • IDocumentRelationships
        • Document Relationships
        • Filtering by Relationships
        • Filtering by Relationships
        • Creating Relationships
      • IDocumentSearch
        • Document Search Criteria
        • Document Search Criteria
        • Document Searching
      • IDocumentSettings
        • Export Document Settings
        • Import Document Settings
        • Meta-Data Extraction
        • Document Deleting
        • Document Deleting
        • Generate Thumbnails
        • Iterating Document Types
        • Document Settings
      • IDocumentTag
        • Deleting All Tags
        • Merging Tags
        • Creating Tags
        • Updating Tags
        • Updating Tags
        • Creating Tags
      • IDocumentTags
        • Advanced Tags
        • Advanced Tags
        • Advanced Tags
        • Advanced Tags
        • Creating Tags
        • Deleting All Tags
        • Iterating Tags
        • Updating Tags
      • IDocumentTagsForDocument
        • Iterating Tags
        • Associated Tags
      • IDocumentThumbnailGenerator
        • Thumbnail Generation
      • IDocumentThumbnailGenerators
        • Iterating ThumbnailGenerators
        • Thumbnail Generation
      • IDocumentType
        • Iterating Document Types
        • Creating Documents
        • Iterating Document Types
      • IDocumentTypes
        • Finding Types for extensions
        • Iterating Document Types
      • IDocuments
        • Creating Customer Documents
        • Creating Other Documents
        • Creating Project Documents
        • Creating Documents
        • Creating Documents from Streams
        • Using the IDocumentCreator Advanced
        • Using the IDocumentCreator Simple
        • Iterating History
        • Filtering by Relationship
        • Document Paging
        • Checking for Database Documents
        • Creating Customer Documents
        • Creating Project Documents
        • Document Paging
        • Iterating Documents
      • IDocumentsRelationship
        • Filtering by Relationship
      • IDrawing
        • SaveAs with Auto-Numbering
        • SaveAs Auto-Numbering
        • Find layer referenced by border plot area
        • Coordinate Systems
        • Copying entities
        • Writing Database Values
        • Using IDocumentCreator for Unsaved Projects
        • Drawing Type Example
        • Exporting a drawing
        • Export Specific Layers
        • Get drawing extents
        • Auto Numbering
        • Get Unreferenced Blocks
        • Get Drawing Last Point
        • Printing all open drawings
        • Updating Dynamic Text
        • Saving Active Drawing
        • Saving Projects
        • Saving Symbols
        • Saving Templates
        • Writing Special Values
        • Saving Projects2
        • Save Drawing As Image
        • Listing The Symbol In A Drawing
        • Describing all text style sheets
        • Updating Database Palettes
        • Updating Various Items
        • Reading-Writing Drawing Variables
        • Saving Active Drawing
        • Saving Projects
        • Saving Symbols
        • Saving Templates
        • Update Various Items
      • IDrawingVariableSettings
        • Converting IML variables
        • Deleting IML variables
        • Checking for IML variables
      • IEnquireArea
        • Enquire Area
      • IEnquireInsertions
        • Enquire insertions
        • Mimic the Enquire - Palette & Symbol Usage tool
      • IEnquireLengths
        • Calculate entity lengths within a text entity
        • Enquire Individual Lengths of Cut palettes
        • Enquire using Palettes and PaletteTypes
        • Enquire within all Symbols inserted into a Block
        • Mimic the Enquire - Palette & Symbol Usage tool
        • Total Cut Lengths specifying EntityTypes
      • IEntity
        • Copy To Block
        • Deleting all the entities in the active block
        • Comparing two entities using the Is method
        • Transforming an entity
      • IExplodeOptions
        • Exploding
      • IFolder
        • Adding Folders
        • Deleting Folders
        • Folder Translations
        • Finding Folders
        • Folder Finding
        • Example Of FindItemsBySQL For Folder
        • Folder Translations
        • Adding Folders
        • Deleting Folders
        • Find Folders
        • Folder Info
        • Folder Setting Properties
        • Recursive Folder Info
      • IFonts
        • Describing all fonts available to the system
      • IGraphic
        • Creating a graphic entity
        • Creating a graphic solid fill
      • IGraphicFace
        • Creating a graphic solid fill
      • IGraphicImage
        • Creating a graphic entity
      • IGraphicImages
        • Creating a graphic entity
        • Describing all images in the drawing
        • Loading a jpeg image
        • Loading a pdf image
        • Loading a pdf image using automatic artwork alignment
        • Loading an image from a document
        • Saving an image as a document
      • IHatchOptions
        • Example Use Of Hatcher And Hatcher Options
      • IHatcher
        • Example Use Of Hatcher And Hatcher Options
        • Example Use Of Hatcher And Hatcher Options
      • IHoleFinder
        • Example use of hole-finder object
      • IHolePathOptions
        • Example use of hole-finder object
      • IImageFormatParams
        • Saving a graphic entity
      • IImportExportMasterSetting
        • Import-Export Master Tool Settings
      • IInsertEntity
        • Insertion types
        • Getting the matrix of an insert
      • ILDAPUserAccountStatus
        • Users Domain Account Statuses
        • Users Domain Info
      • ILanguage
        • Describing all languages available to the system.
      • ILanguages
        • Describing all languages available to the system.
      • ILayer
        • Example Of BoxContainsEntities
        • Converts a block insert to a layer insert
        • Convert a layer insert to a block insert
        • NewLayer Auto-Task
        • NewLayer Auto-Task
        • Copying a layer
        • Writing Database Values
        • Display Dialog
        • Exporting all layers in a drawing
        • NewLayer Auto-Task
        • Example Of GetFittedExtents
        • Getting the fitted extents of the active layer
        • Example Of GetKnifeToKnifeExtents
        • Getting the knife to knife extents of the active layer
        • Layer types
        • Calculate the machine utilisation for a layout
        • Creating a layout
        • Get layout information
        • Creating a common knife block in the active layer
        • NewLayer Auto-Task
        • Example Of OneUpArea
        • Updating Dynamic Text
        • Removing a common knife block from a layer in the active drawing
        • Determine certain calculated text values
        • Save layer as image
        • Save Layer As Image
        • Example Of SetActiveBlock
        • Clearing Standard Information
        • Getting and setting the stock sheet
        • Changing layer visibility
        • Display layer attributes
        • Reading-Writing Layer Variables
        • Various Layer Properties
      • ILayers
        • Creating a new layer
        • Adding A Layer
      • ILayoutOptions
        • Calculate the machine utilisation for a layout
      • ILibraryObject
        • Displaying the library objects available with the current licence.
      • ILine
        • Adding a bridge to a line
        • Example Of AddBridge
        • Display palette text
        • Example Of Extend
        • Extending a line
        • Get Entity Extents
        • Intersect Entity
        • Assign Palette To Line
        • Parameter Along
        • Point On Side
        • Secondary Palette
        • Select A Line
        • Split Line At Point
        • Splitting a line at its midpoint
        • Determine If Entity Is Stale
        • Modify Start Point Of Line
        • Entity Advanced Properties
      • ILinearDimension
        • Modify dimension text attributes
      • ILog
        • Writing to the debug log
      • ILookup
        • Get the names and primary keys of all customers
      • ILookups
        • Get the names and primary keys of all customers
      • IMasterSetting
        • Inspecting Database and MTS Sites
        • Inspecting MTS Filtered by Site
        • Loading a Master Tool Setting
      • IMasterSettings
        • Reading master settings
      • IMatrix
        • MirrorAboutAxis
        • Getting the matrix of an insert
        • Mirroring about axis
        • Transforming a vector
        • Transforming an entity
      • IPDFUtilities
        • Merging PDF Documents
      • IPalette
        • Displaying the bridging information of a palette
        • Displaying the display information of a palette
        • Enquire Cut Lengths
        • Change visibility of palette
        • Change visibility of palette
      • IPaletteBridgeInfo
        • Displaying the bridging information of a palette
      • IPaletteDisplayInfo
        • Displaying the display information of a palette
      • IPaletteOptions
        • Displaying the palette used for construction entities
        • Modifying the palette used for construction entities
        • Displaying the palette used for dimension entities
        • Modifying the palette used for dimension entities
        • Displaying the palette used for text entities
        • Modifying the palette used for text entities
      • IPalettes
        • Add Database Palettes
        • Deleting a palette
        • Finding palettes
        • Finding palettes by type
      • IPathFinder
        • Example use of path-finder object
      • IPlotOptions
        • Plotting
      • IPostScriptImageOptions
        • Loading a pdf image
      • IPrintOptions
        • Determining printer options
        • Printing all open drawings
        • Printing all options
        • Printing to default printer
        • Printing to last used printer
        • Printing with to specific printer
      • IProjectAndLayerFilterOptions
        • Project and layer status
      • IRebridgeOptions
        • Rebridging
      • IReleaseAction
        • Project Release Auto-Task
        • Simple Release
      • ISQLFilterCondition
        • Using CountLayers and FindLayers with SQLfilterConditions
      • IServerLicences
        • Installed Licences
      • IShape
        • Various shape properties
        • Entity clipping and masking using shapes
        • Offset a shape and create entities from it
        • Determine if a shape encloses an entity
        • Determine if a shape encloses a point
        • Various shape properties
        • Various shape properties
        • Shape Intersection
        • Entity clipping and masking using shapes
        • Offset a shape and create entities from it
        • Various shape properties
        • Various shape properties
        • Various shape properties
        • Uniting multiple shapes
        • Simple shape example
        • Various shape properties
      • IShapeCreator
        • Simple shape example
        • Creating a shape from a block insertion
        • Creating a shape from a sequence of points
        • Creating a shape from another shape with a transformation
        • Creating a shape from visible regions
        • Creating sausage shapes
        • Simple shape example
        • Simple shape example
      • IShapes
        • Uniting multiple shapes
      • ISite
        • Inspecting Database and MTS Sites
        • Creating Site Documents
        • Inspecting Database and MTS Sites
        • Inspecting Database and MTS Sites
        • Inspecting Database and MTS Sites
      • ISites
        • Inspecting Database and MTS Sites
        • Inspecting MTS Filtered by Site
      • ISmoothOptions
        • Smoothing entities
      • IStandardCreator
        • Display Standard Wizard
        • Standard Creating
        • Advanced Standard Options
        • Display Standard Wizard
        • Metric-Imperial Standard
        • Recalculating Variables
        • Run a Standard
        • Run a Standard in existing layer
        • Standard Variables
      • IStandardSet
        • Standard Set Info
      • IStandardSets
        • Iterate Standard Sets
      • ISymbol
        • Block and symbol visibility
      • ISystem
        • Describing all languages available to the system.
        • Creating text entities in every font
        • Describing all fonts available to the system
        • Describing all languages available to the system.
        • Show system and version info
      • IText
        • Setting the command
        • Describing all text entities in the drawing
      • ITextStyleSheets
        • Creating a new text style sheet based upon another
        • Creating a new text style that is a copy of another
        • Describing all drawing text style sheets
        • Describing all entity text style sheets
      • IUnitSettings
        • Conversion with unit settings
        • Conversion with unit settings
      • IUnits
        • DistanceFormat
      • IUser
        • Add User with Address
        • User Info
        • Creating User Documents
        • Iterating User Documents
        • Working Projects
        • Users Domain Info
        • Users Domain Info
        • Update Domain Users
        • Users Domain Account Statuses
        • Sending Messages
        • Inspecting Database and MTS Sites
        • Inspecting MTS Filtered by Site
        • Working Documents
        • Users Info
      • IUsers
        • Adding a user
        • Adding a user
        • Adding multiple users
        • Add Domain User
        • Find user by key
        • Find users by name
        • Find user by login id
      • IVariables
        • Adding Variables
        • Deleting Variables
        • Drawing Variables - Reading & Writing
        • Layer Variables - Reading & Writing
        • Recalculate Variables
      • IVector
        • Adding two vectors
        • Assigning one vector to another
        • Caculate distance between two vectors
        • Divide a vector by a given value
        • Compare two vectors
        • Multiplies a vector by a given value
        • Negating the values of a vector
        • Rotating a vector
        • Subtracting one vector from another
        • Transforming a vector
      • IVersion
        • Show system and version info
      • IViewSettings
        • ViewSettings example
        • ViewSettings example
        • ViewSettings example
        • ViewSettings example
      • IWindow
        • Applying a saved visibility
        • SaveToFile
        • Saving a graphic entity
        • ViewBox
Back to top

IDocumentTag¶

Examples for IDocumentTag class.

delete¶

  • Deleting All Tags

merge_to¶

  • Merging Tags

synonyms¶

  • Creating Tags
  • Updating Tags

value¶

  • Updating Tags

Class Examples¶

  • Creating Tags
Next
Deleting All Tags
Previous
Document Settings
Copyright © 2026, Arden Software
Made with Sphinx and @pradyunsg's Furo
On this page
  • IDocumentTag
    • delete
    • merge_to
    • synonyms
    • value
    • Class Examples