## On this page

  

 

 # ZOSAPI.Preferences Namespace Reference

 Last update: 19.09.2025 

## <a id="nested-classes" name="nested-classes"></a>Classes

interface [IPreferencesEditor](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_editor.xhtml) Allows configuration of settings from the OpticStudio Preferences -&gt; Editor tab in OpticStudio.   
[More...](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_editor.xhtml#details)  
 interface [IPreferencesFolders](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_folders.xhtml) Allows configuration of settings from the OpticStudio Preferences -&gt; Folders tab in OpticStudio.   
[More...](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_folders.xhtml#details)  
 interface [IPreferencesGeneral](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_general.xhtml) Allows configuration of settings from the OpticStudio Preferences -&gt; General tab in OpticStudio. Only a subset of preferences can be configured via the ZOS-API as most settings do not have any effect. [More...](interface_z_o_s_a_p_i_1_1_preferences_1_1_i_preferences_general.xhtml#details)  
 ## <a id="enum-members" name="enum-members"></a>Enumerations

enum [ShowLineAsType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a141d74cc029faf333d7dba3e6ddc1822) { [TextAbove](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a141d74cc029faf333d7dba3e6ddc1822aea85e1956c7e02417a1d01332d0d8a4e) = 0 , [FileName](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a141d74cc029faf333d7dba3e6ddc1822a1e621df39e053ff6bc7db7bb1c616cc1) = 1 , [ConfigurationNumber](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a141d74cc029faf333d7dba3e6ddc1822a8060a12b320fd03568abb6489b900725) = 2 } enum [DateTimeType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#ab048650ed5ceba4b5e6ec8cd71ff4c71) { [None](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#ab048650ed5ceba4b5e6ec8cd71ff4c71a6adf97f83acf6453d4a6a4b1070f3754) = 0 , [Date](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#ab048650ed5ceba4b5e6ec8cd71ff4c71a44749712dbec183e983dcd78a7736c41) = 1 , [DateTime](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#ab048650ed5ceba4b5e6ec8cd71ff4c71a8cf10d2341ed01492506085688270c1e) = 2 } enum [LanguageType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a429970572226aa6bca915255fa519b01) { [Chinese](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a429970572226aa6bca915255fa519b01a3b261136e3c33f35e0a58611b1f344cb) = 0 , [English](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a429970572226aa6bca915255fa519b01a78463a384a5aa4fad5fa73e2f506ecfc) = 1 , [Japanese](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a429970572226aa6bca915255fa519b01af32ced6a9ba164c4b3c047fd1d7c882e) = 4 } enum [EncodingType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a93a22c90b7e52910935c4656489ae476) { [ANSI](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a93a22c90b7e52910935c4656489ae476ad403321c965e6b83c88e6d3b1eca5270) = 0 , [Unicode](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a93a22c90b7e52910935c4656489ae476a7f6c02d96265dd1d37b1101de1101541) = 1 } enum [ZemaxThemes](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#af08b094a06a7ef90ee7f3521da55b55a) { [Classic](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#af08b094a06a7ef90ee7f3521da55b55aad35b51b639528d580362ca7042de6a0e) = 0 , [Dark](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#af08b094a06a7ef90ee7f3521da55b55aaa18366b217ebf811ad1886e4f4f865b2) = 1 } enum [BackgroundColors](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0) {   
 [Default](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0a7a1920d61156abc05a60135aefe8bc67) = 0 , [White](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0a25a81701fbfa4a1efdf660a950c1d006) = 1 , [LightGray](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0afb55202637692de4a494e9ade4cff2dd) = 2 , [Gray](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0a994ae1d9731cebe455aff211bcb25b93) = 3 ,   
 [DarkGray](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0a91e93fc984985226ad4d319a4e4134ab) = 4 , [Black](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0ae90dfb84e30edf611e326eeb04d680de) = 5   
 }## Enumeration Type Documentation

<a id="a88ab1a7c6fee2806d8bf21696ed47dc0" name="a88ab1a7c6fee2806d8bf21696ed47dc0"></a>## [◆ ](#a88ab1a7c6fee2806d8bf21696ed47dc0)BackgroundColors

 enum [ZOSAPI.Preferences.BackgroundColors](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a88ab1a7c6fee2806d8bf21696ed47dc0)

Enumerator<a id="a88ab1a7c6fee2806d8bf21696ed47dc0a7a1920d61156abc05a60135aefe8bc67" name="a88ab1a7c6fee2806d8bf21696ed47dc0a7a1920d61156abc05a60135aefe8bc67"></a>Default <a id="a88ab1a7c6fee2806d8bf21696ed47dc0a25a81701fbfa4a1efdf660a950c1d006" name="a88ab1a7c6fee2806d8bf21696ed47dc0a25a81701fbfa4a1efdf660a950c1d006"></a>White <a id="a88ab1a7c6fee2806d8bf21696ed47dc0afb55202637692de4a494e9ade4cff2dd" name="a88ab1a7c6fee2806d8bf21696ed47dc0afb55202637692de4a494e9ade4cff2dd"></a>LightGray <a id="a88ab1a7c6fee2806d8bf21696ed47dc0a994ae1d9731cebe455aff211bcb25b93" name="a88ab1a7c6fee2806d8bf21696ed47dc0a994ae1d9731cebe455aff211bcb25b93"></a>Gray <a id="a88ab1a7c6fee2806d8bf21696ed47dc0a91e93fc984985226ad4d319a4e4134ab" name="a88ab1a7c6fee2806d8bf21696ed47dc0a91e93fc984985226ad4d319a4e4134ab"></a>DarkGray <a id="a88ab1a7c6fee2806d8bf21696ed47dc0ae90dfb84e30edf611e326eeb04d680de" name="a88ab1a7c6fee2806d8bf21696ed47dc0ae90dfb84e30edf611e326eeb04d680de"></a>Black 



<a id="ab048650ed5ceba4b5e6ec8cd71ff4c71" name="ab048650ed5ceba4b5e6ec8cd71ff4c71"></a>## [◆ ](#ab048650ed5ceba4b5e6ec8cd71ff4c71)DateTimeType

 enum [ZOSAPI.Preferences.DateTimeType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#ab048650ed5ceba4b5e6ec8cd71ff4c71)

Enumerator<a id="ab048650ed5ceba4b5e6ec8cd71ff4c71a6adf97f83acf6453d4a6a4b1070f3754" name="ab048650ed5ceba4b5e6ec8cd71ff4c71a6adf97f83acf6453d4a6a4b1070f3754"></a>None <a id="ab048650ed5ceba4b5e6ec8cd71ff4c71a44749712dbec183e983dcd78a7736c41" name="ab048650ed5ceba4b5e6ec8cd71ff4c71a44749712dbec183e983dcd78a7736c41"></a>Date <a id="ab048650ed5ceba4b5e6ec8cd71ff4c71a8cf10d2341ed01492506085688270c1e" name="ab048650ed5ceba4b5e6ec8cd71ff4c71a8cf10d2341ed01492506085688270c1e"></a>DateTime 



<a id="a93a22c90b7e52910935c4656489ae476" name="a93a22c90b7e52910935c4656489ae476"></a>## [◆ ](#a93a22c90b7e52910935c4656489ae476)EncodingType

 enum [ZOSAPI.Preferences.EncodingType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a93a22c90b7e52910935c4656489ae476)

Enumerator<a id="a93a22c90b7e52910935c4656489ae476ad403321c965e6b83c88e6d3b1eca5270" name="a93a22c90b7e52910935c4656489ae476ad403321c965e6b83c88e6d3b1eca5270"></a>ANSI <a id="a93a22c90b7e52910935c4656489ae476a7f6c02d96265dd1d37b1101de1101541" name="a93a22c90b7e52910935c4656489ae476a7f6c02d96265dd1d37b1101de1101541"></a>Unicode 



<a id="a429970572226aa6bca915255fa519b01" name="a429970572226aa6bca915255fa519b01"></a>## [◆ ](#a429970572226aa6bca915255fa519b01)LanguageType

 enum [ZOSAPI.Preferences.LanguageType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a429970572226aa6bca915255fa519b01)

Enumerator<a id="a429970572226aa6bca915255fa519b01a3b261136e3c33f35e0a58611b1f344cb" name="a429970572226aa6bca915255fa519b01a3b261136e3c33f35e0a58611b1f344cb"></a>Chinese <a id="a429970572226aa6bca915255fa519b01a78463a384a5aa4fad5fa73e2f506ecfc" name="a429970572226aa6bca915255fa519b01a78463a384a5aa4fad5fa73e2f506ecfc"></a>English <a id="a429970572226aa6bca915255fa519b01af32ced6a9ba164c4b3c047fd1d7c882e" name="a429970572226aa6bca915255fa519b01af32ced6a9ba164c4b3c047fd1d7c882e"></a>Japanese 



<a id="a141d74cc029faf333d7dba3e6ddc1822" name="a141d74cc029faf333d7dba3e6ddc1822"></a>## [◆ ](#a141d74cc029faf333d7dba3e6ddc1822)ShowLineAsType

 enum [ZOSAPI.Preferences.ShowLineAsType](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#a141d74cc029faf333d7dba3e6ddc1822)

Enumerator<a id="a141d74cc029faf333d7dba3e6ddc1822aea85e1956c7e02417a1d01332d0d8a4e" name="a141d74cc029faf333d7dba3e6ddc1822aea85e1956c7e02417a1d01332d0d8a4e"></a>TextAbove <a id="a141d74cc029faf333d7dba3e6ddc1822a1e621df39e053ff6bc7db7bb1c616cc1" name="a141d74cc029faf333d7dba3e6ddc1822a1e621df39e053ff6bc7db7bb1c616cc1"></a>FileName <a id="a141d74cc029faf333d7dba3e6ddc1822a8060a12b320fd03568abb6489b900725" name="a141d74cc029faf333d7dba3e6ddc1822a8060a12b320fd03568abb6489b900725"></a>ConfigurationNumber 



<a id="af08b094a06a7ef90ee7f3521da55b55a" name="af08b094a06a7ef90ee7f3521da55b55a"></a>## [◆ ](#af08b094a06a7ef90ee7f3521da55b55a)ZemaxThemes

 enum [ZOSAPI.Preferences.ZemaxThemes](namespace_z_o_s_a_p_i_1_1_preferences.xhtml#af08b094a06a7ef90ee7f3521da55b55a)

Enumerator<a id="af08b094a06a7ef90ee7f3521da55b55aad35b51b639528d580362ca7042de6a0e" name="af08b094a06a7ef90ee7f3521da55b55aad35b51b639528d580362ca7042de6a0e"></a>Classic <a id="af08b094a06a7ef90ee7f3521da55b55aaa18366b217ebf811ad1886e4f4f865b2" name="af08b094a06a7ef90ee7f3521da55b55aaa18366b217ebf811ad1886e4f4f865b2"></a>Dark