# UI

### UI Class

Manages the client UI.

### Syntax

### Member Details

#### AddProgressBar Method

> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [UIProgressBar](https://help.sansar.com/hc/en-us/articles/360028869831) **AddProgressBar** ()
>
> **Returns**
>
> > The newly created [Sansar.Simulation.UIProgressBar](https://help.sansar.com/hc/en-us/articles/360028869831).
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### CloseDetailView Method

> Close any open world detail view.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **CloseDetailView** ()
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### GetProgressBars Method

> Gets the progress bars that have been added to the ui.
>
> #### Syntax
>
> **Returns**
>
> > An IEnumarable collection of progress bar objects.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### HintText Property

> The hint text being shown to the user.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **HintText** { get; set; }
>
> **Value**
>
> > The hint text.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### ModalDialog Property

> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [ModalDialog](https://help.sansar.com/hc/en-us/articles/115003435507) **ModalDialog** { get; }
>
> **Value**
>
> > The [Sansar.Simulation.ModalDialog](https://help.sansar.com/hc/en-us/articles/115003435507) for this UI.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### OpenDetailViewForUri Method

> Opens a window showing details for a sansar uri, giving the a user an option to travel to that location.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **OpenDetailViewForUri** ([string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) sansarUri)
>
> **Parameters**
>
> > *sansarUri*
> >
> > The location to open the detail panel for.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### ToString Method

> A string representation of this object.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public override [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **ToString** ()
>
> **Returns**
>
> > A string representation of this object.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

***

### UIProgressBar Class

Manages a progress bar UI element.

### Syntax

### Member Details

#### Cancel Method

> Remove a progress bar.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **Cancel** ()
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Id Property

> The bar's ID.
>
> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) **Id** { get; }
>
> **Value**
>
> > Documentation for this section has not yet been entered.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Label Property

> The bar's current Label
>
> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **Label** { get; }
>
> **Value**
>
> > Documentation for this section has not yet been entered.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Start Method

> Start a progress bar.
>
> #### Syntax
>
> **Parameters**
>
> > *label*
> >
> > Text of the bar.
> >
> > *durationSeconds*
> >
> > Duration.
> >
> > *color*
> >
> > Color.
>
> **Returns**
>
> > The internal event id for the completion event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Start Method

> Start a progress bar.
>
> #### Syntax
>
> **Parameters**
>
> > *label*
> >
> > Text of the bar.
> >
> > *durationSeconds*
> >
> > Duration.
> >
> > *color*
> >
> > Color.
> >
> > *handler*
> >
> > Handler to be called when the event completes.
>
> **Returns**
>
> > The internal event id for the completion event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### ToString Method

> A string representation of this object.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public override [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **ToString** ()
>
> **Returns**
>
> > A string representation of this object.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***