36 | Loads an interface for making calls into Vault Explorer.
37 |
38 |
39 |
40 |
41 | Loads an interface for making calls into Vault Explorer.
42 | The server to connect to.The vault name.The ID of the logged in user.The authentication ticket.
43 | An interface for making calls into Vault Explorer.
44 |
45 |
46 | Loads an interface for making calls into Vault Explorer.
47 | The folder where Vault Explorer is installed.An folder for DLL overrides. Used in cases where the default Vault Explorer DLLs can't load properly. Vaule may be null.The Vault product that is installed.The server to connect to.The vault name.The ID of the logged in user.The authentication ticket.
48 | An interface for making calls into Vault Explorer.
49 |
50 |
51 | The basic Vault product.
52 |
53 |
54 | The Vault Collaboration product.
55 |
56 |
57 | The Vault Professional product.
58 |
59 |
60 | The Vault Workgroup product.
61 |
62 |
63 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Latest News - This repository is going to be obsolete soon. Review the new Job Collection repo instead: https://github.com/koechlm/Autodesk.TS.Vault-Job-Collection
2 |
3 | # Vault-Inventor-Server EXPORT / Navisworks Import / Solidworks PDF Export -- JOB SAMPLE
4 |
5 | This custom job creates Inventor export format files using VaultInventorServer or Navisworks NWD files from any format Navisworks supports.
6 |
7 | INTRODUCTION:
8 | ---------------------------------
9 | This sample walks you through the basic concept handling Inventor part or assembly files submitted to the job queue by VaultInventorServer.
10 | To open 3D part files as well as full assemblies maintaining all file references, the job leverages Vault project file settings initializing the job execution.
11 | File download and running the Inventor translator add-in for CAD-Export formats follow as major execution step.
12 | The final steps adds export files to Vault, copying user properties, trying to synchronize revision index and lifecycle state, and finally attaches the result to their source respectively.
13 |
14 | REQUIREMENTS:
15 | ---------------------------------
16 | Vault Vault Professional 2025 or newer. This job leverages the Vault Inventor Server component and does not require Inventor installation or Inventor license.
17 | However, the new option to create Navisworks files, requires Navisworks Manage installed on the Job Processor machine.
18 | The Solidworks PDF Export option requires Solidworks installed on the Job Processor machine.
19 | The job is valid for any Vault configuration fulfilling these requirements:
20 | - Enforce Workingfolder = Enabled
21 | - Enforce Inventor Project File = Enabled
22 | - Single project file in Vault.
23 | - Category Design Representation (as default configuration "Manufacturing")
24 | - Category Design Representation Assignement Rule based on File classification "Design Representation" (as default configuration "Manufacturing")
25 | - Matching Revision scheme for source file category and design representation category
26 | - Matching Lifecycle State names for lifecycles applied to source and to export files
27 | - Job processor user need to have transition access to life cycle of design representation category
28 |
29 | TO CONFIGURE:
30 | ---------------------------------
31 | 1) Copy the folder Autodesk.VltInvSrv.ExportSampleJob to %ProgramData%\Autodesk\Vault 202x\Extensions\.
32 | 2) Edit the settings.xml to configure the logfile directory; the default is "C:\Temp\".
33 | 3) Edit the settings.xml to configure the export format(s) per Job; multiple formats are allowed e.g., to create a STEP for Sheet Metal folded model
34 | and a DXF for the Sheet Metal Flat Pattern add the values STP, SMDXF to STP,SMDXF. To enable dual export for Sheet Metal components
35 | a category for these part files is expected; configure the name of the category using the element SmCadDispName e.g., Sheet Metal Part
36 | Several copies of the setting.xml represent configurations for STEP and JT, STEP and Sheet Metal DXF and IDW -> DWG export tasks.
37 | 4) Add the job to the Job Queue activating job transitions. To achieve this, integrate this job into a custom lifecycle transition by adding the Job-Type name
38 | "Autodesk.VltInvSrv.ExportSampleJob" to the transition's 'Custom Job Types' tab.
39 |
40 | DISCLAIMER:
41 | ---------------------------------
42 | In any case, all binaries, configuration code, templates and snippets of this solution are of "work in progress" character. This also applies to GitHub "Release" versions.
43 | Neither Markus Koechl, nor Autodesk represents that these samples are reliable, accurate, complete, or otherwise valid.
44 | Accordingly, those configuration samples are provided “as is” with no warranty of any kind and you use the applications at your own risk.
45 |
46 |
47 | NOTES/KNOWN ISSUES:
48 | ---------------------------------
49 | The job expects that all library definition files configured in the Inventor project file are available in the file system. Otherwise, the job might fail with unhandled exception due to missing style library or other settings files.
50 |
51 | VERSION HISTORY / RELEASE NOTES:
52 | ---------------------------------
53 | 2025.2.0.1 - added template support for Navisworks NWD creation. Added option to allow the reuse of local IPJ file.
54 | 2025.1.0.0 - enhanced Navisworks export and added Navisworks DWF visualization export, added Solidworks PDF export option (design representation attachment)
55 | 2025.0.0.0 - updated for 2025 compatibility
56 | 2024.0.0.0 - updated for 2024 compatibility
57 | 2023.1.0.0 - implemented export to Navisworks NWD(+NWC)
58 | 2023.0.0.0 - updated for 2023
59 | 2022.3.0.x - support Image export for IPT, IAM, IDW/DWG; image formats PNG, BMP, GIF, JPG and TIFF are configurable
60 | 2022.2.0.1 - support 2D and 3D export file formats while respecting matching source file types (IPT, IAM, IDW/DWG)
61 | support 2D DWG (IDW/DWG) and 3D DWG (IPT, IAM) export targets
62 | updated settings and settings.xml sample configurations
63 | 2022.1.0.2 - added IDW -> DWG export capabilities; improved logging and error handling; fixed download issue for multilevel assembly files;
64 | fixed IPJ activation issue on first run on fresh machines; fixed issue #7: Exported files don't attach to latest parent iteration
65 | 2022.0.42.0 - updated 2022
66 | 2021.26.0.0 - updated 2021
67 | 2020.25.1.0 - Added Export-Format Configuration, Output Folder option, named and published as Autodesk.VltInvSrv.ExportSampleJob,
68 | implemented formats are STEP, JT and Sheet Metal Flat Pattern DXF
69 | 2020.25.0.3 - Added Logging, named and published as Autodesk.STEP.ExportSampleJob
70 | 2020.25.0.0 - Initial Version, named and published as Autodesk.STEP.ExportSampleJob
71 |
72 | ---------------------------------
73 |
74 | Thank you for your interest in Autodesk Vault solutions and API samples.
75 |
76 | Sincerely,
77 |
78 | Markus Koechl, Autodesk
79 |
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.Connectivity.JobProcessor.Extensibility.XML:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.Connectivity.JobProcessor.Extensibility
5 |
6 |
7 |
8 | A Job from from the queue.
9 |
10 |
11 | The interface that Job Handlers must implement.
12 |
13 |
14 | Utilities for interfacing with the application.
15 |
16 |
17 | Gets the description of the job.
18 |
19 |
20 | Gets the unique ID.
21 |
22 |
23 | Gets the job type.
24 |
25 |
26 | Gets the set of parameters on the job.
27 |
28 |
29 | Gets the priority of the job. Lower number means higher priorty. 1 is the highest priority. Less than 1 is not allowed.
30 |
31 |
32 | Gets the Vault that the Job references.
33 |
34 |
35 | Called at Job Processor startup to determine whither or not a job of the specified type can be processed by the job handler on this particular machine.
36 | Implementations should check to see whether enabling software is installed.
37 | The job type.
38 | True if the handler can process the job. False if the handler cannot process the job.
39 |
40 |
41 | The Execute method processes the job and returns success or failure
42 | The application context.The job to process.
43 | The outcome of the processing.
44 |
45 |
46 | Called when the Job Processor is closing.
47 |
48 |
49 | Called when the Job Processor process is about to sleep.
50 |
51 |
52 | Called at Job Processor startup.
53 |
54 |
55 | Called when the Job Processor process wakes from sleeping.
56 |
57 |
58 |
59 |
60 | Logs a message.
61 |
62 |
63 |
64 |
65 | Lets the application know how close to completion the job is.
66 | How close to completion the job is.
67 |
68 |
69 | Logs a message.
70 | The message Text.Type type of message.
71 |
72 |
73 | Logs an exception.
74 | The exception to log.The message Text.
75 |
76 |
77 | Gets / Sets if it's allowed to retry the job in case of failure.
78 |
79 |
80 | Gets a Connection object for communicating with the servers.
81 |
82 |
83 | Gets the list of all errors logged so far.
84 |
85 |
86 | Gets an object which could be force cast to type Inventor.InventorServer and used like Inventor.Application. This object should be initialized and released by
87 | framework. Extension developer doesn't need to take care of that.
88 |
89 |
90 | The outcome of the Job processing.
91 |
92 |
93 | The type of logging message.
94 |
95 |
96 | An exception to pass back to the application.
97 |
98 |
99 | Creates a new exception.
100 | A message describing the error.A flag describing permission to retry job.
101 |
102 |
103 | Property of permission to retry job
104 |
105 |
106 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | ## Ignore Visual Studio temporary files, build results, and
2 | ## files generated by popular Visual Studio add-ons.
3 | ##
4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
5 |
6 | # User-specific files
7 | *.rsuser
8 | *.suo
9 | *.user
10 | *.userosscache
11 | *.sln.docstates
12 |
13 | # User-specific files (MonoDevelop/Xamarin Studio)
14 | *.userprefs
15 |
16 | # Build results
17 | [Dd]ebug/
18 | [Dd]ebugPublic/
19 | [Rr]elease/
20 | [Rr]eleases/
21 | x64/
22 | x86/
23 | [Aa][Rr][Mm]/
24 | [Aa][Rr][Mm]64/
25 | bld/
26 | [Bb]in/
27 | [Oo]bj/
28 | [Ll]og/
29 |
30 | # Visual Studio 2015/2017 cache/options directory
31 | .vs/
32 | # Uncomment if you have tasks that create the project's static files in wwwroot
33 | #wwwroot/
34 |
35 | # Visual Studio 2017 auto generated files
36 | Generated\ Files/
37 |
38 | # MSTest test Results
39 | [Tt]est[Rr]esult*/
40 | [Bb]uild[Ll]og.*
41 |
42 | # NUNIT
43 | *.VisualState.xml
44 | TestResult.xml
45 |
46 | # Build Results of an ATL Project
47 | [Dd]ebugPS/
48 | [Rr]eleasePS/
49 | dlldata.c
50 |
51 | # Benchmark Results
52 | BenchmarkDotNet.Artifacts/
53 |
54 | # .NET Core
55 | project.lock.json
56 | project.fragment.lock.json
57 | artifacts/
58 |
59 | # StyleCop
60 | StyleCopReport.xml
61 |
62 | # Files built by Visual Studio
63 | *_i.c
64 | *_p.c
65 | *_h.h
66 | *.ilk
67 | *.meta
68 | *.obj
69 | *.iobj
70 | *.pch
71 | *.pdb
72 | *.ipdb
73 | *.pgc
74 | *.pgd
75 | *.rsp
76 | *.sbr
77 | *.tlb
78 | *.tli
79 | *.tlh
80 | *.tmp
81 | *.tmp_proj
82 | *_wpftmp.csproj
83 | *.log
84 | *.vspscc
85 | *.vssscc
86 | .builds
87 | *.pidb
88 | *.svclog
89 | *.scc
90 |
91 | # Chutzpah Test files
92 | _Chutzpah*
93 |
94 | # Visual C++ cache files
95 | ipch/
96 | *.aps
97 | *.ncb
98 | *.opendb
99 | *.opensdf
100 | *.sdf
101 | *.cachefile
102 | *.VC.db
103 | *.VC.VC.opendb
104 |
105 | # Visual Studio profiler
106 | *.psess
107 | *.vsp
108 | *.vspx
109 | *.sap
110 |
111 | # Visual Studio Trace Files
112 | *.e2e
113 |
114 | # TFS 2012 Local Workspace
115 | $tf/
116 |
117 | # Guidance Automation Toolkit
118 | *.gpState
119 |
120 | # ReSharper is a .NET coding add-in
121 | _ReSharper*/
122 | *.[Rr]e[Ss]harper
123 | *.DotSettings.user
124 |
125 | # JustCode is a .NET coding add-in
126 | .JustCode
127 |
128 | # TeamCity is a build add-in
129 | _TeamCity*
130 |
131 | # DotCover is a Code Coverage Tool
132 | *.dotCover
133 |
134 | # AxoCover is a Code Coverage Tool
135 | .axoCover/*
136 | !.axoCover/settings.json
137 |
138 | # Visual Studio code coverage results
139 | *.coverage
140 | *.coveragexml
141 |
142 | # NCrunch
143 | _NCrunch_*
144 | .*crunch*.local.xml
145 | nCrunchTemp_*
146 |
147 | # MightyMoose
148 | *.mm.*
149 | AutoTest.Net/
150 |
151 | # Web workbench (sass)
152 | .sass-cache/
153 |
154 | # Installshield output folder
155 | [Ee]xpress/
156 |
157 | # DocProject is a documentation generator add-in
158 | DocProject/buildhelp/
159 | DocProject/Help/*.HxT
160 | DocProject/Help/*.HxC
161 | DocProject/Help/*.hhc
162 | DocProject/Help/*.hhk
163 | DocProject/Help/*.hhp
164 | DocProject/Help/Html2
165 | DocProject/Help/html
166 |
167 | # Click-Once directory
168 | publish/
169 |
170 | # Publish Web Output
171 | *.[Pp]ublish.xml
172 | *.azurePubxml
173 | # Note: Comment the next line if you want to checkin your web deploy settings,
174 | # but database connection strings (with potential passwords) will be unencrypted
175 | *.pubxml
176 | *.publishproj
177 |
178 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
179 | # checkin your Azure Web App publish settings, but sensitive information contained
180 | # in these scripts will be unencrypted
181 | PublishScripts/
182 |
183 | # NuGet Packages
184 | *.nupkg
185 | # The packages folder can be ignored because of Package Restore
186 | **/[Pp]ackages/*
187 | # except build/, which is used as an MSBuild target.
188 | !**/[Pp]ackages/build/
189 | # Uncomment if necessary however generally it will be regenerated when needed
190 | #!**/[Pp]ackages/repositories.config
191 | # NuGet v3's project.json files produces more ignorable files
192 | *.nuget.props
193 | *.nuget.targets
194 |
195 | # Microsoft Azure Build Output
196 | csx/
197 | *.build.csdef
198 |
199 | # Microsoft Azure Emulator
200 | ecf/
201 | rcf/
202 |
203 | # Windows Store app package directories and files
204 | AppPackages/
205 | BundleArtifacts/
206 | Package.StoreAssociation.xml
207 | _pkginfo.txt
208 | *.appx
209 |
210 | # Visual Studio cache files
211 | # files ending in .cache can be ignored
212 | *.[Cc]ache
213 | # but keep track of directories ending in .cache
214 | !?*.[Cc]ache/
215 |
216 | # Others
217 | ClientBin/
218 | ~$*
219 | *~
220 | *.dbmdl
221 | *.dbproj.schemaview
222 | *.jfm
223 | *.pfx
224 | *.publishsettings
225 | orleans.codegen.cs
226 |
227 | # Including strong name files can present a security risk
228 | # (https://github.com/github/gitignore/pull/2483#issue-259490424)
229 | #*.snk
230 |
231 | # Since there are multiple workflows, uncomment next line to ignore bower_components
232 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
233 | #bower_components/
234 |
235 | # RIA/Silverlight projects
236 | Generated_Code/
237 |
238 | # Backup & report files from converting an old project file
239 | # to a newer Visual Studio version. Backup files are not needed,
240 | # because we have git ;-)
241 | _UpgradeReport_Files/
242 | Backup*/
243 | UpgradeLog*.XML
244 | UpgradeLog*.htm
245 | ServiceFabricBackup/
246 | *.rptproj.bak
247 |
248 | # SQL Server files
249 | *.mdf
250 | *.ldf
251 | *.ndf
252 |
253 | # Business Intelligence projects
254 | *.rdl.data
255 | *.bim.layout
256 | *.bim_*.settings
257 | *.rptproj.rsuser
258 | *- Backup*.rdl
259 |
260 | # Microsoft Fakes
261 | FakesAssemblies/
262 |
263 | # GhostDoc plugin setting file
264 | *.GhostDoc.xml
265 |
266 | # Node.js Tools for Visual Studio
267 | .ntvs_analysis.dat
268 | node_modules/
269 |
270 | # Visual Studio 6 build log
271 | *.plg
272 |
273 | # Visual Studio 6 workspace options file
274 | *.opt
275 |
276 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
277 | *.vbw
278 |
279 | # Visual Studio LightSwitch build output
280 | **/*.HTMLClient/GeneratedArtifacts
281 | **/*.DesktopClient/GeneratedArtifacts
282 | **/*.DesktopClient/ModelManifest.xml
283 | **/*.Server/GeneratedArtifacts
284 | **/*.Server/ModelManifest.xml
285 | _Pvt_Extensions
286 |
287 | # Paket dependency manager
288 | .paket/paket.exe
289 | paket-files/
290 |
291 | # FAKE - F# Make
292 | .fake/
293 |
294 | # JetBrains Rider
295 | .idea/
296 | *.sln.iml
297 |
298 | # CodeRush personal settings
299 | .cr/personal
300 |
301 | # Python Tools for Visual Studio (PTVS)
302 | __pycache__/
303 | *.pyc
304 |
305 | # Cake - Uncomment if you are using it
306 | # tools/**
307 | # !tools/packages.config
308 |
309 | # Tabs Studio
310 | *.tss
311 |
312 | # Telerik's JustMock configuration file
313 | *.jmconfig
314 |
315 | # BizTalk build output
316 | *.btp.cs
317 | *.btm.cs
318 | *.odx.cs
319 | *.xsd.cs
320 |
321 | # OpenCover UI analysis results
322 | OpenCover/
323 |
324 | # Azure Stream Analytics local run output
325 | ASALocalRun/
326 |
327 | # MSBuild Binary and Structured Log
328 | *.binlog
329 |
330 | # NVidia Nsight GPU debugger configuration file
331 | *.nvuser
332 |
333 | # MFractors (Xamarin productivity tool) working folder
334 | .mfractor/
335 |
336 | # Local History for Visual Studio
337 | .localhistory/
338 |
339 | # BeatPulse healthcheck temp database
340 | healthchecksdb
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.Navisworks.Controls.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.Navisworks.Controls
5 |
6 |
7 |
8 |
9 | Allows initialization/shutdown of the API when using Navisworks controls.
10 | Note that this is not the same as automation as you haven’t got a full Navisworks application running.
11 |
12 |
13 |
14 |
15 | Specifies the type of application that will be built using Navisworks controls. The
16 | default is MultipleDocument.
17 | Must be called before Initialize.
18 |
19 |
20 | The API has already been initialized using ApplicationControl.Initialize()
21 |
22 |
23 |
24 | By default Navisworks files are held open whilst being viewed.
25 |
26 |
27 | The API has not yet been initialized using ApplicationControl.Initialize()
28 |
29 |
30 |
31 | Initialise the API. Safe to call multiple times, each call must have matching call
32 | to Terminate.
33 |
34 |
35 | The program is trying to use a Navisworks control but the control
36 | can't find a Navisworks runtime to use. For example if no Navisworks product is installed.
37 |
38 |
39 |
40 |
41 | Indicates whether Hardware Acceleration is actually being used.
42 |
43 |
44 | The API has not yet been initialized using ApplicationControl.Initialize()
45 |
46 |
47 |
48 | Indicates whether Hardware Acceleration is available.
49 |
50 |
51 | The API has not yet been initialized using ApplicationControl.Initialize()
52 |
53 |
54 |
55 | Is the API initialized and ready for use ?
56 |
57 |
58 |
59 |
60 | Specifies whether Hardware Acceleration should be used if available.
61 |
62 |
63 | The API has not yet been initialized using ApplicationControl.Initialize()
64 |
65 |
66 |
67 | Specifies the language that Navisworks should prefer (if installed).
68 | Must be called before Initialize.
69 |
70 |
71 | The API has already been initialized using ApplicationControl.Initialize()
72 |
73 |
74 |
75 | Specifies the Selection Behavior to be used during Picking.
76 |
77 |
78 | The API has not yet been initialized using ApplicationControl.Initialize()
79 |
80 |
81 |
82 | Sets/clears the implementation of IApplicationGui returned by
83 | Application.Gui.
84 |
85 |
86 |
87 |
88 | Terminate use of the API. Each call must have a matching call
89 | to Initialize.
90 |
91 |
92 |
93 |
94 | Describes the type of application that will be built using Navisworks controls.
95 |
96 |
97 |
98 |
99 | Multiple document application.
100 | Any number of DocumentControls may be created.
101 | A multiple document application supports a limited set of Navisworks APIs and Navisworks native
102 | file formats.
103 |
104 |
105 |
106 |
107 | Single document application.
108 | Only one DocumentControl may be created.
109 | A single document application supports the complete set of Navisworks APIs and file readers.
110 |
111 |
112 |
113 |
114 | Standalone component that manages a Navisworks document
115 |
116 |
117 |
118 | Default constructor for DocumentControl
119 |
120 |
121 |
122 | Overloaded constructor for DocumentControl.
123 | This should be used where possible.
124 |
125 |
126 |
127 |
128 | Gets a reference to the Navisworks Document
129 |
130 | The API has not yet been initialized using ApplicationControl.Initialize()
131 |
132 |
133 | Attempt to access a second Document when
134 | ApplicationControl.ApplicationType is set to SingleDocument
135 |
136 |
137 |
138 |
139 | Set this control's document as the main document for the application. This should be called
140 | once at the beginning of the application. This DocumentControl should last for the lifetime
141 | of the application and be the last DocumentControl to be disposed when the application terminates.
142 |
143 |
144 | The API has not yet been initialized using ApplicationControl.Initialize()
145 |
146 |
147 |
148 |
149 | Shows the modal dialog for Culling Options.
150 |
151 |
152 | The API has not yet been initialized using ApplicationControl.Initialize()
153 |
154 |
155 |
156 |
157 | Standalone control that provides a graphical view of the Document in a DocumentControl.
158 |
159 |
160 |
161 | Default constructor for ViewControl
162 |
163 |
164 | Determines if Selection dragging is enabled
165 |
166 |
167 |
168 | The DocumentControl that this view displays
169 |
170 |
171 |
172 | Determines whether the specified key is a regular input key or a special key that requires preprocessing.
173 |
174 |
175 | Sets this as the active view for the purposes of the DocumentControl
176 |
177 |
178 | Gets a reference to the Navisworks View
179 |
180 |
181 | When overridden provides access to specific windows messages handled by the control during its lifetime.
182 |
183 |
184 |
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.Navisworks.Automation.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.Navisworks.Automation
5 |
6 |
7 |
8 |
9 | Automation equivalent of DocumentFileException
10 |
11 |
12 |
13 | Creates a AutomationDocumentFileException object
14 |
15 |
16 | Creates a AutomationDocumentFileException
17 |
18 |
19 | Creates a AutomationDocumentFileException object
20 | The error message that explains the reason for the exception.
21 |
22 |
23 | Creates a AutomationDocumentFileException object
24 | The error message that explains the reason for the exception.
25 | The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
26 |
27 |
28 |
29 | Specific Exception that is thrown by the .NET Automation parts of the API when there is a general failure of Automation
30 |
31 |
32 |
33 | Creates a AutomationException object
34 |
35 |
36 | Creates a AutomationException
37 |
38 |
39 | Creates a AutomationException object
40 | The error message that explains the reason for the exception.
41 |
42 |
43 | Creates a AutomationException object
44 | The error message that explains the reason for the exception.
45 | The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
46 |
47 |
48 |
49 | Provides the same interface as Autodesk.Navisworks.Api.ApplicationParts.ApplicationAutomation but via Automation.
50 | Calls made via this class eventually call methods on Autodesk.Navisworks.Api.ApplicationParts.ApplicationAutomation.
51 |
52 |
53 |
54 |
55 | Attempts to start up an instance of Navisworks. This will not make it visible.
56 |
57 |
58 | throws if Navisworks fails to start
59 |
60 |
61 |
62 |
63 | Adds another assembly that plugins can be loaded from.
64 | Assembly is loaded using the LoadFrom context and can be outside the Application root.
65 |
66 |
67 | The file name of the assembly
68 |
69 |
70 |
71 |
72 | Appends a Navisworks supported files to the currently loaded file
73 |
74 | The file name including extension
75 |
76 | Failed to append file
77 |
78 |
79 |
80 |
81 | Creates a corresponding nwc file for specified file.
82 |
83 |
84 |
85 |
86 | Normal behavior is that Progress is displayed when performing long operations, even during Automated actions.
87 | Calling this method changes behaviour such that Progress is not displayed in such cirmumstances.
88 |
89 |
90 |
91 |
92 |
93 |
94 | Normal behavior is that Progress is displayed when performing long operations, even during Automated actions.
95 | This may have been overriden by using DisableProgress,
96 | If so then calling this method will reinstate normal behavior.
97 |
98 |
99 |
100 |
101 | Executes an Addin Plugin whose full name is given by pluginId, passing in the paramaters given.
102 |
103 | The full identifier for the plugin. This is formed as
104 | PluginRecord::Name.PluginRecord::DeveloperId
105 |
106 | Optional parameters to pass to the plugin
107 |
108 |
109 |
110 |
111 | Gets hold of currently running instance of the Application.
112 |
113 |
114 | The running NavisworksApplication.
115 |
116 |
117 | Cannot get running instance of Application
118 |
119 |
120 |
121 |
122 | Loads one or more Navisworks supported files
123 |
124 | first file to load
125 |
126 |
127 | Failed to open file
128 |
129 |
130 |
131 |
132 | Sends the current View to the Printer
133 |
134 |
135 |
136 |
137 | Sends the current View to the Printer
138 |
139 | The name of the printer to print to
140 |
141 |
142 |
143 | Sends the current View to the Printer
144 |
145 | The name of the printer to print to
146 | The name of the printer driver to use
147 |
148 |
149 |
150 | Sends the current View to the Printer
151 |
152 | The name of the printer to print to
153 | The name of the printer driver to use
154 | The name of the port the printer is connected to
155 |
156 |
157 |
158 | Save the documents loaded using OpenFile to a single Navisworks Document
159 |
160 | The file name including extension
161 |
162 | Failed to save file
163 |
164 |
165 |
166 |
167 | Normal behaviour is that the instance of Navisworks closes when the NavisworksApplication is Disposed or Finalized.
168 |
169 |
170 |
171 |
172 | Gets hold of currently running instance of the Application.
173 |
174 |
175 | The running NavisworksApplication or null if there on failure.
176 |
177 |
178 |
179 |
180 | Controls whether the Navisworks application GUI is visible
181 |
182 |
183 | throws if get/set fails
184 |
185 |
186 |
187 |
--------------------------------------------------------------------------------
/Autodesk.VLTINVSRV.ExportSampleJob/Autodesk.VLTINVSRV.ExportSampleJob.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Debug
6 | AnyCPU
7 | {385B4EFE-36BE-485D-A533-1E84369D1BEA}
8 | Library
9 | Properties
10 | Autodesk.VltInvSrv.ExportSampleJob
11 | Autodesk.VltInvSrv.ExportSampleJob
12 | v4.8
13 | 512
14 |
15 |
16 |
17 | true
18 | full
19 | false
20 | ..\..\..\..\..\..\ProgramData\Autodesk\Vault 2020\Extensions\Autodesk.VltInvSrv.ExportSampleJob\
21 | DEBUG;TRACE
22 | prompt
23 | 4
24 | x64
25 |
26 |
27 | pdbonly
28 | true
29 | bin\Release\
30 | TRACE
31 | prompt
32 | 4
33 |
34 |
35 | true
36 |
37 |
38 | Key.snk
39 |
40 |
41 | true
42 | bin\x64\Debug\2025\
43 | TRACE;DEBUG
44 | full
45 | x64
46 | prompt
47 | MinimumRecommendedRules.ruleset
48 | false
49 |
50 |
51 | bin\x64\Release\2025\
52 | TRACE
53 | true
54 | pdbonly
55 | x64
56 | prompt
57 | MinimumRecommendedRules.ruleset
58 |
59 |
60 |
61 | False
62 | SDK Refs\Autodesk.Connectivity.Explorer.Extensibility.dll
63 | False
64 |
65 |
66 | SDK Refs\Autodesk.Connectivity.Explorer.ExtensibilityTools.dll
67 | False
68 |
69 |
70 | False
71 | SDK Refs\Autodesk.Connectivity.Extensibility.Framework.dll
72 | False
73 |
74 |
75 | False
76 | SDK Refs\Autodesk.Connectivity.JobProcessor.Extensibility.dll
77 | False
78 |
79 |
80 | False
81 | SDK Refs\Autodesk.Connectivity.WebServices.dll
82 | False
83 |
84 |
85 | False
86 | SDK Refs\Autodesk.DataManagement.Client.Framework.dll
87 | False
88 |
89 |
90 | False
91 | SDK Refs\Autodesk.DataManagement.Client.Framework.Vault.dll
92 | False
93 |
94 |
95 | False
96 | True
97 | SDK Refs\Autodesk.Inventor.Interop.dll
98 |
99 |
100 | False
101 | SDK Refs\Autodesk.Navisworks.Api.dll
102 |
103 |
104 | False
105 | SDK Refs\Autodesk.Navisworks.Automation.dll
106 |
107 |
108 | False
109 | SDK Refs\Autodesk.Navisworks.Controls.dll
110 |
111 |
112 | False
113 | SDK Refs\Autodesk.Navisworks.Resolver.dll
114 |
115 |
116 | SDK Refs\SolidWorks.Interop.sldworks.dll
117 | True
118 |
119 |
120 | SDK Refs\SolidWorks.Interop.swconst.dll
121 | True
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 | .editorconfig
142 |
143 |
144 | Always
145 |
146 |
147 | PreserveNewest
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 | Designer
174 | PreserveNewest
175 |
176 |
177 | Designer
178 | PreserveNewest
179 |
180 |
181 | PreserveNewest
182 | Designer
183 |
184 |
185 |
186 |
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.Connectivity.Extensibility.Framework.XML:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.Connectivity.Extensibility.Framework
5 |
6 |
7 |
8 | The dotnet DotNameRuntime requirements.
9 |
10 |
11 | Can run in netcore and netFramework mode.
12 |
13 |
14 | Can only run in NetFramework mode.
15 |
16 |
17 | Can only run in netcore and net5+ mode.
18 |
19 |
20 | Error codes used for ExtensionExceptions
21 |
22 |
23 | The status of the load operation on an Extension.
24 |
25 |
26 | NotAttempted
27 |
28 |
29 | Success
30 |
31 |
32 | Failure
33 |
34 |
35 | An enumeration of different ways to locate extensions within a folder
36 |
37 |
38 | Extension should be in the current folder only
39 |
40 |
41 | Extensions should only be in immediate sub folders
42 |
43 |
44 | Extensions can be in the current folder and sub-folders any levels deep
45 |
46 |
47 | The runtime requirements.
48 |
49 |
50 | Can run in any mode. Default.
51 |
52 |
53 | Can only run in 32-bit mode.
54 |
55 |
56 | Can only run in 64-bit mode.
57 |
58 |
59 | Gets the type of lookup for a resolve folder.
60 |
61 |
62 | The lookup involves the Windows registry.
63 |
64 |
65 | The lookup is the location of the Vault Explorer client.
66 |
67 |
68 | The lookup is relative to the location of the extension's DLL.
69 |
70 |
71 | Define the [assembly: ApiVersion] attribute which MUST be specified for your extension to be loaded.
72 |
73 |
74 | The non-generic base class for Extension types
75 |
76 |
77 | Represents a class which imlements a Vault Extension interface.
78 |
79 |
80 | An assembly which contains Vault Extensions.
81 |
82 |
83 | An Exception class for Vault extensions.
84 |
85 |
86 | Represents a folder to load extensions from
87 |
88 |
89 | Define the [assembly: ExtensionId] attribute which MUST be specified for your extension to be loaded. Each extension should have a unique ID.
90 |
91 |
92 | A utility for loading extensions.
93 |
94 |
95 | Settings class which can be used on construction of ExtensionLoader
96 |
97 |
98 | A restriction from a Vault Extension.
99 |
100 |
101 | An object representing the contents of a .vcet.config file.
102 |
103 |
104 | An object representing an extension.
105 |
106 |
107 | An object representing the settings component of a .vcet.config file.
108 |
109 |
110 | A folder to be used when resolving .NET DLL references.
111 |
112 |
113 | A key/value pair on the extension. Used for setting meta-data on the extension. How the meta-data is used depends on the extension type.
114 |
115 |
116 | Create an ApiVersionAttribute
117 | Version of the API the command extension is written for.
118 |
119 |
120 | Gets the version string.
121 |
122 |
123 | Gets the runtime this extension will work on.
124 |
125 |
126 | Gets the load paths that are added to the PATH environment variable.
127 |
128 |
129 | Gets the assembly that this Extension belongs to.
130 |
131 |
132 | Gets the Vault Extension interface that the Extension supports.
133 |
134 |
135 | Gets the Type string of this Extension.
136 |
137 |
138 | Gets the location of this Extension's configuration file on disk.
139 |
140 |
141 | Gets the additional load paths defined in the .vcet.config file.
142 |
143 |
144 | Gets the runtime this extension will work on.
145 |
146 |
147 | Gets or sets the object that contains meta-data about the object.
148 |
149 |
150 | Creates a new object that supports the Extension interface.
151 | The new object supporting the Extension interface.
152 |
153 |
154 | Reset the create initial instance data to its default settings. The data will be populated again on the next created instance of the Extension class.
155 |
156 |
157 | Gets the exception if initial instance creation failed.
158 |
159 |
160 | Gets the status of fist instance creation
161 |
162 |
163 | Gets the TimeSpan of creating the initial instance.
164 |
165 |
166 | Gets the settings defined in the .vcet.config file.
167 |
168 |
169 | Gets the API Version attribute for the assembly.
170 |
171 |
172 | Gets the AssemblyCompany attribute for the assembly.
173 |
174 |
175 | Gets the AssemblyDescription attribute for the assembly.
176 |
177 |
178 | Gets the ExtensionId attribute for the assembly.
179 |
180 |
181 | The Vault extensions contained within the assembly.
182 |
183 |
184 | Gets the folder path to the extension.
185 |
186 |
187 | If load failed, this is the exception
188 |
189 |
190 | Gets a value indicating if the Assembly has been loaded or not.
191 |
192 |
193 | Time taken to load the assembly
194 |
195 |
196 | Gets the AssemblyProduct attribute for the assembly.
197 |
198 |
199 | File name of the registration config file
200 |
201 |
202 | After successful load, should required assembly attributes be checked for
203 |
204 |
205 |
206 |
207 | Creates a new exception for Vault Extension related activities.
208 |
209 |
210 |
211 |
212 | Creates a new exception for Vault Extension related activities.
213 | The error code.A human readable message.Restriction information. Cannot be nullThe inner exception.
214 |
215 |
216 | Creates a new exception for Vault Extension related activities.
217 | The error code.A human readable message.Restriction information. Cannot be null
218 |
219 |
220 | Creates a new exception for Vault Extension related activities.
221 | The error code.A human readable message.The inner exception.
222 |
223 |
224 | Creates a new exception for Vault Extension related activities.
225 | The error code.A human readable message.
226 |
227 |
228 | Gets the contents of the .vcet.Config file.
229 |
230 |
231 | Gets the path to the .vcet.config file.
232 |
233 |
234 | Gets the error code string.
235 |
236 |
237 | Gets the error code.
238 |
239 |
240 | Gets the interface name that failed to load
241 |
242 |
243 | Gets the VcetExtension associated with the exception.
244 |
245 |
246 | Gets or sets the metadata about the error.
247 |
248 |
249 | Gets the collection of restrictions.
250 |
251 |
252 | The constructor
253 | The path to load extension from.How extensions should be located.If true, the extensions should be loaded according to the Autodesk App Store rules. If false, anything with a .vcet.config will be considered to be an
254 | Extension. The default value is false.
255 |
256 |
257 | Gets a value indicating that App Store rules should be used for detecting extensions.
258 |
259 |
260 | Gets the folder path.
261 |
262 |
263 | Gets a value indicating how extensions should be located.
264 |
265 |
266 | Create an ExtensionIdAttribute
267 | The unique ID for the extension.
268 |
269 |
270 | Gets the unique ID for the extension.
271 |
272 |
273 | The constructor
274 |
275 |
276 | The constructor with ExtensionLoaderSettings
277 |
278 |
279 | Adds a new location where the loader looks when loading extensions.
280 | The extensions folder.
281 |
282 |
283 | Locate all the Extensions of a given type, but don't load them.
284 | The iterface to scan for.
285 | A collection of all matching Extension or an empty collection of there are no matches.
286 |
287 |
288 | Returns a list of resolve paths for all loaded extensions.
289 | The list of resolve paths for all loaded extensions.
290 |
291 |
292 | Returns the extention folders that the loader is using to find extensions.
293 | The extention folders that the loader is using to find extensions.
294 |
295 |
296 | Loads the assemblies for a given Extension if they haven't been loaded already.
297 | The Extension to load.
298 |
299 |
300 | Sets the locations where the loader looks for extensions.
301 | A collection of folder paths.
302 |
303 |
304 | Locate all the Extensions of a given type and load them into memory.
305 | The iterface to scan for.
306 | A collection of all matching Extension or an empty collection of there are no matches.
307 |
308 |
309 | Loads the assemblies for a given set of Extensions if they haven't been loaded already.
310 | The Extensions to load.
311 |
312 |
313 | Gets the default folder for loading Vault Extensions.
314 |
315 |
316 | Gets the collection of load exceptions.
317 |
318 |
319 | Gets a value indicating if the find operation for all of the assemblies (config files) been done.
320 |
321 |
322 | Gets the API Version supported by the current framework.
323 |
324 |
325 | The constructor.
326 | If true, assemblies will only load if the required attributes are set. If false, missing attributes will not cause a load failure.The extension of the config file. Set to null for the default case, .vcet.config.
327 |
328 |
329 | Gets the file extension for the config files.
330 |
331 |
332 | Gets if the assembly attributes are required.
333 |
334 |
335 | The constructor for a restriction.
336 | A human readable description of the object which is failing.A human readable message indicating what the problem is.
337 |
338 |
339 | Gets the human readable message indicating what the problem is.
340 |
341 |
342 | Gets the human readable description of the object which is failing.
343 |
344 |
345 | Gets the name of the extenension that created the restriction.
346 |
347 |
348 | Gets the path to the .vcet.config file.
349 |
350 |
351 | Gets the folder containing the .vcet.config file.
352 |
353 |
354 | Gets or sets the contents of the Cconnectivity.ExtensionSetting tag.
355 |
356 |
357 | Gets or sets the runtime requirements,set the default vaule equals Framework
358 |
359 |
360 | Gets or sets the interface that is used to communicate with the extension.
361 |
362 |
363 | Gets or sets the list of resolve folders.
364 |
365 |
366 | Gets or sets the runtime requirements.
367 |
368 |
369 | Gets or sets the settings, which are key=value pairs used to assist in loading and configuring extensions.
370 |
371 |
372 | Gets or sets the type of the class that implements the interface.
373 |
374 |
375 | Gets or sets the collection of Extensions.
376 |
377 |
378 | Gets or sets if this resolve folder should be added to the PATH environment variable.
379 |
380 |
381 | Gets or sets the type of lookup for finding the actual folder path.
382 |
383 |
384 | Gets or sets the relative path for the lookup. Only used if the lookup type is RelativeToExtension.
385 |
386 |
387 | Gets or sets the registry key for the lookup. Only used if the lookup type is Registry.
388 |
389 |
390 | Gets or sets the registry name for the lookup. Only used if the lookup type is Registry.
391 |
392 |
393 | Gets or sets the setting key. Key must be unique within an extension.
394 |
395 |
396 | Gets or sets the setting value.
397 |
398 |
399 |
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.DataManagement.Client.Framework.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.DataManagement.Client.Framework
5 |
6 |
7 |
8 | Provides a gateway to all features and services in Autodesk.DataManagement.Client.Framework assembly.
9 |
10 |
11 | Initializes the services in this assembly. This should be called on application startup.
12 | Pass true if this is a UI application that has a message pump (e.g. Winforms, MFC, WPF). Pass false otherwise (e.g. a Console app)
13 |
14 |
15 | Sets the culture that this assembly will use when returning resources.
16 | The culture to set
17 |
18 |
19 | Gets or sets the application name that will be displayed in captions for various dialogs
20 |
21 |
22 | Gets or sets the application version
23 |
24 |
25 | Gets a service used to inspect an exception object and return information about it.
26 |
27 |
28 | Gets a service which associates a custom exception parser with a particular type of exception.
29 |
30 |
31 | Gets or sets the interface that the Framework will use for logging.
32 |
33 |
34 | Gets or sets the main application thread. Some properties retrieval (ie. File System Icon) and other operations can only be performed properly on the main
35 | application thread.
36 |
37 |
38 | Gets whether an Invoke is required in order to execute on the thread the MainThreadDispatcher is associated with. Returns true when the current thread is
39 | different than the MainThreadDispatcher's thread. Returns false when the MainThreadDispatcher is null or the current thread is the same as the
40 | MainThreadDispatcher's thread.
41 |
42 |
43 | Gets a Properties dictionary that can be used by applications to store global state.
44 |
45 |
46 | The size of a windows shell icon.
47 |
48 |
49 | Represents a 16 x 16 image
50 |
51 |
52 | Represents a 32 x 32 image
53 |
54 |
55 | Represents a 48 x 48 image
56 |
57 |
58 | Represents a 256 x 256 image
59 |
60 |
61 | A Dictionary in which the values can be replaced with a function that computes the value.
62 | The data type of the Key to the dictionaryThe data type of the Values in the dictionary
63 |
64 |
65 | An ExceptionRestriction is extra data that is optionally packaged with an exception.
66 |
67 |
68 | A class representing the local path of a file.
69 |
70 |
71 | A class representing the local path of a folder.
72 |
73 |
74 | Represents an individual line item of data that can be displayed in a progress dialog. Progress can be reported with Name/Value pairs, or just as an individual
75 | value.
76 |
77 |
78 | A restriction is a combination of a restricted object and a reason why an operation failed on the object. An example would be a restriction on deleting a file,
79 | becuase a link to the file still exists. All other more specific restrictions types inherit from this base class.
80 |
81 |
82 | A class representing the abosulte path of a file in Vault.
83 |
84 |
85 | Removes all keys and values from the Dictionary.
86 |
87 |
88 | Determines whether the Dictionary contains an element with the key element of the specified key/value pair.
89 | The key/value pair whose key will be used to locate an item in the dictionary
90 | true if the dictionary contains an element with the key
91 |
92 |
93 | Determines whether the Dictionary contains an element with the specified key.
94 | The key to locate in the Dictionary
95 | true if the dictionary contains an element with the key; otherwise, false
96 |
97 |
98 | Gets an enumerator of key/value pairs for all of the elements in the dictionary
99 | An enumertor of all of the elements in the dictionary
100 |
101 |
102 | Gets the value associated with the specified key.
103 | The key whose value to get.When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.
104 | This parameter is passed uninitialized.
105 | true if the Dictionary contains an element with the specified key; otherwise, false
106 |
107 |
108 | Adds an element with the provided key and function which is used to compute the value
109 | The object to use as the key of the element to add.The function which will be called to compute the value when this item is retrieved from the dictionary
110 |
111 |
112 | Adds an element with the provided key and value
113 | The object to use as the key of the element to add.The object to use as the value of the element to add.
114 |
115 |
116 | Adds an element with the provided key/value pair
117 | The key/value pair to add to the dictionary
118 |
119 |
120 | Removes the element with the specified key from the Dictionary
121 | The key of the element to remove.
122 | true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original Dictionary
123 |
124 |
125 | Removes the element with the key component of the specified key/value pair from the Dictionary
126 | The key/value pair to remove from the dictionary
127 | true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original Dictionary
128 |
129 |
130 | Gets the number of key/value pairs contained in the Dictionary
131 |
132 |
133 | Gets or sets the element with the specified key.
134 | The key of the element to get or set.
135 | The element with the specified key.
136 |
137 |
138 | Gets an System.Collections.Generic.ICollection containing the keys of Dictionary
139 |
140 |
141 | Gets an System.Collections.Generic.ICollection containing the values in the Dictionary<TKey,TValue>
142 |
143 |
144 | Creates a Restriction object
145 | A numeric value that uniquely identifies this restriction.A collection of data that is specific to each restriction code.
146 |
147 |
148 | A collection of additional information associated with this restriction.
149 |
150 |
151 | A numeric value that uniquely identifies this restriction.
152 |
153 |
154 | A full, abolute path to a file, including its file name.
155 | The full, absolute path to the file, including the file name.
156 |
157 |
158 | A full, abolute path to a file, including its file name.
159 | A .NET utility object for a file on disk
160 |
161 |
162 | The file extension.
163 |
164 |
165 | The name of the file with extension.
166 |
167 |
168 | The path of the folder.
169 |
170 |
171 | The full, absolute path including the file name.
172 |
173 |
174 | A full, absolute path to a folder.
175 | The full, absolute path to the folder.
176 |
177 |
178 | The full, absolute path of the folder.
179 |
180 |
181 | Constructs an instance of the ProgressValue class with a name/value pair
182 | The label to use in a name/value pair (ie. the "File" component of "File: XYZ")The value to use in a name/value pair (ie. the "XYZ" component of "File: XYZ")
183 |
184 |
185 | Constructs an instance of the ProgressValue class with a standalone value
186 | The value to display as progress (ie. "File XYZ downloading")
187 |
188 |
189 | Gets of sets the name component of a name/value pair (ie. the "File" component of "File: XYZ")
190 |
191 |
192 | Gets or sets the value component of a progress item. This value may or may not be paired with a Label to describe the value.
193 |
194 |
195 | Constructs an instance of the Restriction class.
196 | The name of the object that this restriction is about.The description of the reason for the restriction.Optional paramenter specifying if the restriction can be overridden.
197 |
198 |
199 | Constructs an instance of the Restriction class with restriction text and reason.
200 | The name of the object that this restriction is about.The description of the reason for the restriction.The reason of restriction if needed 3rd column.Optional paramenter specifying if the restriction can be overridden.
201 |
202 |
203 | Gets if the resriction can be overridden by the user.
204 |
205 |
206 | Gets the name of the object that this restriction affects.
207 |
208 |
209 | Gets the reason for this restriction if needed.
210 |
211 |
212 | Gets the reson for this restriction.
213 |
214 |
215 | Constructor for VaultFilePathAbsolute
216 | The full Vault path to the file. Must be rooted.
217 |
218 |
219 | The name of the file with extension.
220 |
221 |
222 | The path of the folder.
223 |
224 |
225 | The absolute path to the Vault file.
226 |
227 |
228 | Represents a read-only dictionary
229 |
230 |
231 | Provides details about a specific type of Exception object.
232 |
233 |
234 | This interface defines what the VDF expects from a logging system.
235 |
236 |
237 | Provides a mechanism for a business logic layer to report results back to the GUI
238 |
239 |
240 | Determines whether the dictionary contains an element the specified key.
241 |
242 |
243 | Gets the value associated with the specified key. If the key is not found, the value returned is default value for the type.
244 | true if the an element with the specified key exists; otherwise, false
245 |
246 |
247 | Gets the element with the specified key
248 |
249 |
250 | Gets the keys of the dictionary
251 |
252 |
253 | Gets the values of the dictionary
254 |
255 |
256 | Returns an error code that identifies the error. Not all exception types support this but it can be of use for certain types if the app wants to have special
257 | business logic to handle an error
258 | The exception object to be parsed.
259 | The error code associated with the exception. This may be null or empty if the exception type does not support error codes.
260 |
261 |
262 | Retrieves a textual description of the exception
263 | The exception object to be parsed.
264 | The textual description of the exception. This should never be null or empty.
265 |
266 |
267 | Returns a list of restrictions that may be embedded in an exception object.
268 | The exception object to be parsed.
269 | A list of restrictions associated with the exception. This may be null or an empty list if there are no exceptions.
270 |
271 |
272 | Retrieves a caption to display in a dialog box for an exception. This can return a generic message like "Error", but it can also return a more detailed message
273 | like "File Access Error" where the GetMessage() would return more specific details on the error
274 | The exception object to be parsed.
275 | The caption to display in a dialog box which displays information about the exception. This should never be null or empty.
276 |
277 |
278 | Returns true if the exception is one that could happen naturally and should be handled gracefully...not as a fatal error. For example "File checked out to
279 | another user" is an expected exception. "Object reference not found" or "Index out of range" is not
280 | The exception object to be parsed.
281 |
282 |
283 | Gets the type of exception that is managed by this provider
284 |
285 |
286 | Log a message to the logging system.
287 | The main category.An optional sub category.The message to be logged.System.Diagnostics.TraceEventTypePriority to assign to the message.UTC start of the of the message. Gives user (optionally) the ability to assign the start time.Optional list of property name/object pairs to assicated to the log message.
288 |
289 |
290 | Reports progress to the GUI layer
291 | The caption of a progress dialog. This should describe the overall operationThe header of the progress report. This should describe the current state of the operation, at a high levelA list of values to display about the current state. This might include file names, file sizes, or other statisticsThe % of the overall workflow that has been completed. If not specified, then no cumulative progress indicator will be displayed
292 |
293 |
294 | Reports progress to the GUI layer
295 | The header of the progress report. This should describe the current state of the operation, at a high levelA list of values to display about the current state. This might include file names, file sizes, or other statisticsThe % of the overall workflow that has been completed. If not specified, then no cumulative progress indicator will be displayed
296 |
297 |
298 | Associates a custom exception parser with a particular type of exception.
299 |
300 |
301 | This service is used to inspect an exception object and return information about it.
302 |
303 |
304 | Retrieves the parser that is used to interrogate an exception object.
305 | The exception to retrieve a parser for.
306 | The provider used to parse . This should never be null because the framework has a built in parser registered with the base class. That parser will be used
307 | as a last resort.
308 |
309 |
310 | Registers a parser with a particular type of exception object. That parser will be used to inspect all exceptions of the specified type.
311 | The parser that is used to retrieve information about exceptions for this type.
312 |
313 |
314 | Returns an error code that identifies the error.
315 | The exception to parse.
316 | The error code associated with the exception. This can be null or empty if the exception type does not support an error code.
317 |
318 |
319 | Gets descriptive text which describes the exception.
320 | The exception to parse.
321 | The text which describes the exception.
322 |
323 |
324 | Gets a list of restrictions that may be embedded in an exception object.
325 | The exception to parse.
326 | The list of restrictions embedded in the exception. This can be null or an empty list if there are no restrictions.
327 |
328 |
329 | Gets a caption to display in a dialog box for an exception.
330 | The exception to parse.
331 | The caption to display in a dialog box.
332 |
333 |
334 | Determines if an exception is one that could happen naturally and should be handled gracefully or a fatal error.
335 | The exception to parse.
336 | True if the exception is expected. False otherwise.
337 |
338 |
339 |
--------------------------------------------------------------------------------
/Autodesk.VltInvSrv.ExportSampleJob/SDK Refs/Autodesk.Connectivity.Explorer.Extensibility.XML:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Autodesk.Connectivity.Explorer.Extensibility
5 |
6 |
7 |
8 | This is the single top-level object which is passed to your Extension during events
9 |
10 |
11 | Information about the command currently executing
12 |
13 |
14 | Used by DetailPaneTab selection event handlers to interact with the application
15 |
16 |
17 | Interface between Vault Explorer and command extension assemblies.
18 |
19 |
20 | Representation of a selected object in the Vault Explorer.
21 |
22 |
23 | Gets the list of ids for commands that can be hidden
24 |
25 |
26 | Gets a connection to use for making calls to the Vault servers
27 |
28 |
29 | Gets the host's Icon for use in your own dialogs
30 |
31 |
32 | Gets the name of the host application
33 |
34 |
35 | Gets the tab ids that are replaceable
36 |
37 |
38 | Gets the title (displayed in the main window title bar) of the host application
39 |
40 |
41 | Gets the version of the host application
42 |
43 |
44 | Registers event handler to be called on Command Begin.
45 |
46 |
47 | Registers event handler to be called on Command End.
48 |
49 |
50 | Gets interface to the application object
51 |
52 |
53 | Gets the collection of objects that make up the current Vault Explorer selection set
54 |
55 |
56 | Sets the value indicating if a refresh operation should be performed when the command ends. By default, the UI is not updated as doing so could be time
57 | consuming.
58 |
59 |
60 | Sets the value indicating where Vault Explorer should navigate to when the command ends. By default, the location does not change.
61 |
62 |
63 | Gets the items which are selcted in the navigation view (treeview at the left)
64 |
65 |
66 | Gets the items which are selcted in the preview windows (bottom right pane)
67 |
68 |
69 | Gets the items which are selected in the list view (top right pane)
70 |
71 |
72 | Gets the vault explorer UI. The behavior is the same as if the user pressed the F5 key.
73 |
74 |
75 | Gets the application object for the current session.
76 |
77 |
78 | Gets the items which are selcted in the navigation view (treeview at the left).
79 |
80 |
81 | Gets the object that is currently selected. Returns null if no selection.
82 |
83 |
84 | Gets the visible instance of the extension-provided user control type.
85 |
86 |
87 | Extension should create and return a list of CommandSite(s) imlpemented in the extension.
88 | Collection of CommandSite objects to make available in Vault Explorer
89 |
90 |
91 | Extension should create and return a list of CustomEntityHandler(s) to override default commands for custom entity types.
92 | Collection of CustomEntityHandler objects implementing override behavior for specific custom entity types.
93 |
94 |
95 | Extension should create and return a list of DetailPaneTab(s) to be display custom tabs when vault objects are selected.
96 | Collection of DetailPaneTab objects describing tabs implemented by the command extension
97 |
98 |
99 | Extension should create and return a list of ids of commands to be hidden from the user. Command ids should be from the list returned by:
100 | IApplication.CommandIds
101 | A list of ids of commands to be hidden from the user.
102 |
103 |
104 | This function is called when the user logs off and their security context is cleared.
105 | Information about the running application.
106 |
107 |
108 | This function is called when the user logs on and their security context is created.
109 | Information about the running application.
110 |
111 |
112 | OnShutdown() is called as the application begins to shutdown; shortly after the user selects "File/Exit".
113 | Information about the running application.
114 |
115 |
116 | OnStartup() is called just before the user is given control for the first time. The "application" parameter can be used to add commands to the host
117 | application.
118 | Information about the running application.
119 |
120 |
121 | Gets an Id that can be used (along with the Web Service API) to get more information about the object.
122 |
123 |
124 | Gets a descriptive label for the object.
125 |
126 |
127 | Gets a string that represents the Vault Explorer object type. Can be used to determine which service to use for processing of the object.
128 |
129 |
130 | The type of a command site location.
131 |
132 |
133 | Toolbar location.
134 |
135 |
136 | How a command item is presented in a toolbar
137 |
138 |
139 | Provides args to the CommandBegin event
140 |
141 |
142 | Provides args to the CommandEnd event
143 |
144 |
145 | A CommandItem is the pull-right menu entry; CommandItems must be added to a CommandSite.
146 |
147 |
148 | The argument for the CommandItem.Execute event
149 |
150 |
151 | A command site is your top-level menu which is displayed in Vault Explorer's "Tools" menu. Individual commands are pull-rights off of this menu.
152 |
153 |
154 | Where a command site will be deployed in Vault Explorer
155 |
156 |
157 | A custom entity handler provides overrides for certian actions performed on a custom entity object.
158 |
159 |
160 | Describes a custom tab to be displayed in Vault Explorer
161 |
162 |
163 | LocationContext represents a location of a single entity within the Vault Explorer browser.
164 |
165 |
166 | The argument for the DetailPaneTab.SelectionChanged event
167 |
168 |
169 | The type of object that is selected.
170 |
171 |
172 | Gets the Id of the Command to be executed
173 |
174 |
175 | Gets the Id of the Command that was executed
176 |
177 |
178 | Creates a command item.
179 | Command-extension-supplied identifier. This id should be uniqueLabel presented to Vault Explorer users to identify the command
180 |
181 |
182 | Gets or sets the descriptive text that displays for this command in a Customize dialog. It gives more detail about what the command does.
183 |
184 |
185 | Gets or sets the text representing the tooltip contents for the command item
186 |
187 |
188 | Gets the Guid for this CommandItem; each Guid must be unique
189 |
190 |
191 | Gets or sets the image object to be used as the icon for this command. For best result provide a 32x32 image which still looks good when scaled down to 16x16.
192 | Having a transparent color is also suggested.
193 |
194 |
195 | Gets the text displayed in the menu
196 |
197 |
198 | Gets or sets the value that enables multi-select. If true (the default), this command is enabled when multiple items are selected (subject to filtering by
199 | NavigationType). If false, this command is enabled only when a single item is selected.
200 |
201 |
202 | Gets or sets the object types for which this command is available. If not specified, this command is always available.
203 |
204 |
205 | Gets or sets the PaintStyle for this CommandItem when deployed on a toolbar.
206 |
207 |
208 | The Execute event is fired when this command is activated; usually a result of the selecting this menu item.
209 |
210 |
211 | Gets information about the command currently executing.
212 |
213 |
214 | Constructs a CommandSite object with the provided identifier and label
215 | A unique identifier for the site.The display text.
216 |
217 |
218 | Adds a command item to this command site
219 | CommandItem to add to this CommandSite
220 |
221 |
222 | Gets the commands contained in this command site.
223 |
224 |
225 | Gets or sets a boolean indicating whether this command site should appear as a pulldown menu when deployed to a toolbar.
226 |
227 |
228 | Gets the extension-supplied identifier associated with this command site.
229 |
230 |
231 | Gets the extension-supplied label associated with this command site.
232 |
233 |
234 | Gets or sets the CommandSiteLocation associated with this command site.
235 |
236 |
237 | Creates a new CommandSiteLocation object.
238 | The name of the custom entity.The type of the command site location.
239 |
240 |
241 | Gets the entity class that this site is usually associated with. Value may be null.
242 |
243 |
244 | Gets the subtype, which, in the case of custom entities, has the system name of the entity definition. Value may be null.
245 |
246 |
247 | Gets the name of this location.
248 |
249 |
250 | Gets the type of site.
251 |
252 |
253 | The top-level Actions menu.
254 |
255 |
256 | The toolbar for advanced commands.
257 |
258 |
259 | The toolbar for commands related to Behaviors, such as lifecycle state and category.
260 |
261 |
262 | The Change Order context menu.
263 |
264 |
265 | The toolbar for collaborate commands.
266 |
267 |
268 | The top-level Edit menu.
269 |
270 |
271 | The File context menu.
272 |
273 |
274 | The top-level File menu.
275 |
276 |
277 | The Folder context menu.
278 |
279 |
280 | The top-level Help menu.
281 |
282 |
283 | The toolbar for Item BOM commands.
284 |
285 |
286 | The Item context menu.
287 |
288 |
289 | The toolbar for standard commands.
290 |
291 |
292 | The top-level Tools menu.
293 |
294 |
295 | Creates a new handler for operations on entities of a specific custom type.
296 | The system name of the custom entity definition.
297 |
298 |
299 | Gets a value that tells if the handler supports a custom Add command.
300 |
301 |
302 | Gets a value that tells if the handler supports a custom Delete command.
303 |
304 |
305 | Gets or sets name of the custom entity type.
306 |
307 |
308 | Gets or sets a value that indicates if default tab views should be hidden.
309 |
310 |
311 | The AddCustomEntity event is fired when the default New command for this custom entity type.
312 |
313 |
314 | The AddCustomEntity event is fired when the default Delete command for this custom entity type.
315 |
316 |
317 | Creates a DetailPaneTab object
318 | Extension-supplied tab identifier. This id should be uniqueLabel presented to Vault Explorer users in the tab headerThe selection context determines when the tab is displayed.Type of UserControl-derived control for display in the tab
319 |
320 |
321 | Fires the SelectionChanged event. This is the method called when the user changes a selection while the tab is visible, or the tab is made newly visible.
322 | Tab context object
323 |
324 |
325 | Gets the extension-supplied id of this tab
326 |
327 |
328 | Gets the label of this tab
329 |
330 |
331 | Gets or sets the DetailPaneTabId of the tab to be replaced by this tab
332 |
333 |
334 | Gets the container that this tab is displayed in.
335 |
336 |
337 | Gets the extension-supplied user control type
338 |
339 |
340 | This event is triggerred when the selection changes.
341 |
342 |
343 | Creates a reference to a location within Vault Explorer.
344 | The selection type.The unique name of the entity that the context points to. This value must be the full file path, the full folder path, the item number, the change order
345 | number, or the custom entity number.
346 |
347 |
348 | The unique name of the entity that the context points to.
349 |
350 |
351 | The entitiy class that the context points to.
352 |
353 |
354 | Creates SelectionChangedEventArgs object
355 | Current tab context
356 |
357 |
358 | Gets the detail pane tab context
359 |
360 |
361 | Constructs a selection type ID for a custom entity type.
362 | The system name of the custom entity definition.
363 |
364 |
365 | Gets the entity class associated with this type.
366 |
367 |
368 | Gets the subtype, which, in the case of custom entities, has the system name of the entity definition.
369 |
370 |
371 | Gets the context of the selection.
372 |
373 |
374 | Gets the value indicating if custom tab views can be used with this selection type.
375 |
376 |
377 | A selection of an Item in a BOM.
378 |
379 |
380 | A Change Order selection.
381 |
382 |
383 | A File Master (version independent) selection.
384 |
385 |
386 | A selection for a specific version of a File.
387 |
388 |
389 | A Folder selection.
390 |
391 |
392 | A generic Item selection.
393 |
394 |
395 | An unknown or unsupported selection.
396 |
397 |
398 |
--------------------------------------------------------------------------------