## On this page

  

 

 # OpenTD.AddIn.ProgressToken Class Reference

 Last update: 16.07.2025 

<exclude > [More...](#details)

Inheritance diagram for OpenTD.AddIn.ProgressToken:

 ![](/sites/default/files/migrate-content/opentd_refefence_net_8_2025_r2_doc_1/class_open_t_d_1_1_add_in_1_1_progress_token.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

void [SetTitle](#a19061e49e8943038cb8c0f65051f0881) (string title) Sets the title of the progress-indicating object, for example a [ProgressBar](class_open_t_d_1_1_add_in_1_1_progress_bar.xhtml "Use to control the TD/AutoCAD progress bar.").   
 void [Report](#a3048fedfb108dc99ec03ce899092fcc3) (string status) Report progress status, e.g., "Starting to test file 'myfile'".   
 void [Report](#aec23b92af7b635a6a21c65b742cfd268) (int progressPercent) Report on progress as percent complete. Might be used to set a progress bar, for example.   
 void [Show](#a83f332a72e3d995e1d5ea27756887aaf) () void [Hide](#a405736758ef2844507a2b962444d9c28) () ## <a id="events" name="events"></a>Events

EventHandler&lt; AddIn.ProgressEventArgs &gt; [ProgressChanged](#aa6df8d83fd3fc025b35f5562c1995ac3) <a id="details" name="details"></a>## Detailed Description

&lt;exclude &gt;



## Member Function Documentation

<a id="a405736758ef2844507a2b962444d9c28" name="a405736758ef2844507a2b962444d9c28"></a>## [◆ ](#a405736758ef2844507a2b962444d9c28)Hide()

 void OpenTD.AddIn.ProgressToken.Hide  ( )   inline 

Implements [OpenTD.AddIn.IProgressReporter](interface_open_t_d_1_1_add_in_1_1_i_progress_reporter.xhtml#ac8f54eb85e3feaffa46def3eb8a30490).





<a id="aec23b92af7b635a6a21c65b742cfd268" name="aec23b92af7b635a6a21c65b742cfd268"></a>## [◆ ](#aec23b92af7b635a6a21c65b742cfd268)Report() \[1/2\]

 void OpenTD.AddIn.ProgressToken.Report  ( int *progressPercent*)   inline 

Report on progress as percent complete. Might be used to set a progress bar, for example.

Implements [OpenTD.AddIn.IProgressReporter](interface_open_t_d_1_1_add_in_1_1_i_progress_reporter.xhtml#a078d40e383e90adcf45ffae48ada8de8).





<a id="a3048fedfb108dc99ec03ce899092fcc3" name="a3048fedfb108dc99ec03ce899092fcc3"></a>## [◆ ](#a3048fedfb108dc99ec03ce899092fcc3)Report() \[2/2\]

 void OpenTD.AddIn.ProgressToken.Report  ( string *status*)   inline 

Report progress status, e.g., "Starting to test file 'myfile'".

Implements [OpenTD.AddIn.IProgressReporter](interface_open_t_d_1_1_add_in_1_1_i_progress_reporter.xhtml#abb9af2d558ef84b95b134d053b051bb1).





<a id="a19061e49e8943038cb8c0f65051f0881" name="a19061e49e8943038cb8c0f65051f0881"></a>## [◆ ](#a19061e49e8943038cb8c0f65051f0881)SetTitle()

 void OpenTD.AddIn.ProgressToken.SetTitle  ( string *title*)   inline 

Sets the title of the progress-indicating object, for example a [ProgressBar](class_open_t_d_1_1_add_in_1_1_progress_bar.xhtml "Use to control the TD/AutoCAD progress bar.").

Implements [OpenTD.AddIn.IProgressReporter](interface_open_t_d_1_1_add_in_1_1_i_progress_reporter.xhtml#a36f01d3994fcaeeec5f136dfa3b332de).





<a id="a83f332a72e3d995e1d5ea27756887aaf" name="a83f332a72e3d995e1d5ea27756887aaf"></a>## [◆ ](#a83f332a72e3d995e1d5ea27756887aaf)Show()

 void OpenTD.AddIn.ProgressToken.Show  ( )   inline 

Implements [OpenTD.AddIn.IProgressReporter](interface_open_t_d_1_1_add_in_1_1_i_progress_reporter.xhtml#ab8178420838b1c53cbe9a6ccf5901690).





## Event Documentation

<a id="aa6df8d83fd3fc025b35f5562c1995ac3" name="aa6df8d83fd3fc025b35f5562c1995ac3"></a>## [◆ ](#aa6df8d83fd3fc025b35f5562c1995ac3)ProgressChanged

 EventHandler&lt;AddIn.ProgressEventArgs&gt; OpenTD.AddIn.ProgressToken.ProgressChanged





---

The documentation for this class was generated from the following file:- C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/AddIn/**ProgressToken.cs**