# gdip.stringformat 库模块帮助文档

## gdip 成员列表 <a id="gdip" href="#gdip">&#x23;</a>

### gdip.CloneStringFormat <a id="gdip.CloneStringFormat" href="#gdip.CloneStringFormat">&#x23;</a>
`$.api("GdipCloneStringFormat","int(PTR strFmt,int& newFormat)")`

### gdip.CreateStringFormat <a id="gdip.CreateStringFormat" href="#gdip.CreateStringFormat">&#x23;</a>
`$.api("GdipCreateStringFormat","int(int formatAttributes,word language,pointer& StringFormat)")`

### gdip.DeleteStringFormat <a id="gdip.DeleteStringFormat" href="#gdip.DeleteStringFormat">&#x23;</a>
`$.api("GdipDeleteStringFormat","int(PTR strFmt)")`

### gdip.GetStringFormatAlign <a id="gdip.GetStringFormatAlign" href="#gdip.GetStringFormatAlign">&#x23;</a>
`$.api("GdipGetStringFormatAlign","int(PTR strFmt,int& align)")`

### gdip.GetStringFormatFlags <a id="gdip.GetStringFormatFlags" href="#gdip.GetStringFormatFlags">&#x23;</a>
`$.api("GdipGetStringFormatFlags","int(PTR strFmt,int& flags)")`

### gdip.GetStringFormatHotkeyPrefix <a id="gdip.GetStringFormatHotkeyPrefix" href="#gdip.GetStringFormatHotkeyPrefix">&#x23;</a>
`$.api("GdipGetStringFormatHotkeyPrefix","int(PTR strFmt,int& hkPrefix)")`

### gdip.GetStringFormatLineAlign <a id="gdip.GetStringFormatLineAlign" href="#gdip.GetStringFormatLineAlign">&#x23;</a>
`$.api("GdipGetStringFormatLineAlign","int(PTR strFmt,int& align)")`

### gdip.GetStringFormatTrimming <a id="gdip.GetStringFormatTrimming" href="#gdip.GetStringFormatTrimming">&#x23;</a>
`$.api("GdipGetStringFormatTrimming","int(PTR strFmt,int& trimming)")`

### gdip.SetStringFormatAlign <a id="gdip.SetStringFormatAlign" href="#gdip.SetStringFormatAlign">&#x23;</a>
`$.api("GdipSetStringFormatAlign","int(PTR strFmt,int align)")`

### gdip.SetStringFormatFlags <a id="gdip.SetStringFormatFlags" href="#gdip.SetStringFormatFlags">&#x23;</a>
`$.api("GdipSetStringFormatFlags","int(PTR strFmt,int flags)")`

### gdip.SetStringFormatHotkeyPrefix <a id="gdip.SetStringFormatHotkeyPrefix" href="#gdip.SetStringFormatHotkeyPrefix">&#x23;</a>
`$.api("GdipSetStringFormatHotkeyPrefix","int(PTR strFmt,int hkPrefix)")`

### gdip.SetStringFormatLineAlign <a id="gdip.SetStringFormatLineAlign" href="#gdip.SetStringFormatLineAlign">&#x23;</a>
`$.api("GdipSetStringFormatLineAlign","int(PTR strFmt,int align)")`

### gdip.SetStringFormatTrimming <a id="gdip.SetStringFormatTrimming" href="#gdip.SetStringFormatTrimming">&#x23;</a>
`$.api("GdipSetStringFormatTrimming","int(PTR strFmt,int trimming)")`

### gdip.stringformat() <a id="gdip.stringformat" href="#gdip.stringformat">&#x23;</a>
[返回对象:gdipstringformatObject](#gdipstringformatObject)

### gdip.stringformat(formatAttributes,language) <a id="gdip.stringformat" href="#gdip.stringformat">&#x23;</a>
创建文本格式对象  
参数都是可选参数,默认值为0

## gdip.stringformat 成员列表 <a id="gdip.stringformat" href="#gdip.stringformat">&#x23;</a>

### gdip.stringformat.genericTypographic() <a id="gdip.stringformat.genericTypographic" href="#gdip.stringformat.genericTypographic">&#x23;</a>
返回一个格式对象  
测量字符串的长度时，禁止GDI+添加额外长度或宽度  
测量结果偏小  

[返回对象:gdipstringformatObject](#gdipstringformatObject)

## gdipstringformatObject 成员列表 <a id="gdipstringformatObject" href="#gdipstringformatObject">&#x23;</a>

### gdipstringformatObject.align <a id="gdipstringformatObject.align" href="#gdipstringformatObject.align">&#x23;</a>

```aardio
gdipstringformatObject.align = _GdipStringAlignment/*水平对齐*/  ;
```

### gdipstringformatObject.delete() <a id="gdipstringformatObject.delete" href="#gdipstringformatObject.delete">&#x23;</a>
删除对象

### gdipstringformatObject.flags <a id="gdipstringformatObject.flags" href="#gdipstringformatObject.flags">&#x23;</a>

```aardio
gdipstringformatObject.flags = _GdipStringFormatFlags/*选项*/  ;
```

### gdipstringformatObject.getDigitSubstitution() <a id="gdipstringformatObject.getDigitSubstitution" href="#gdipstringformatObject.getDigitSubstitution">&#x23;</a>
获取数字替换方法和对应于数字替换的语言。  
返回 2 个值：langId,substitute ，参考 setDigitSubstitution 方法参数说明。

### gdipstringformatObject.getTabStops() <a id="gdipstringformatObject.getTabStops" href="#gdipstringformatObject.getTabStops">&#x23;</a>
获取置此 StringFormat 对象中制表位的偏移量。  
返回两个值:tabStops,offset 。  
tabStops 为表示多个 `\t` 输出偏移量的数组。  
offset 为起始偏移量，默认为 0

### gdipstringformatObject.hotkeyPrefix <a id="gdipstringformatObject.hotkeyPrefix" href="#gdipstringformatObject.hotkeyPrefix">&#x23;</a>

```aardio
gdipstringformatObject.hotkeyPrefix = _GdipHotkeyPrefix/*热键前缀的处理类型*/  ;
```

### gdipstringformatObject.lineAlign <a id="gdipstringformatObject.lineAlign" href="#gdipstringformatObject.lineAlign">&#x23;</a>

```aardio
gdipstringformatObject.lineAlign = _GdipStringAlignment/*垂直对齐*/ ;
```

### gdipstringformatObject.setDigitSubstitution(langId,substitute) <a id="gdipstringformatObject.setDigitSubstitution" href="#gdipstringformatObject.setDigitSubstitution">&#x23;</a>
设置数字替换方法和对应于数字替换的语言。  
参数 @langId 指定 LANGID（数值），substitute 指定 _gdipStringDigitSubstitute 前缀枚举值（数值）

### gdipstringformatObject.setTabStops(tabStops,offset) <a id="gdipstringformatObject.setTabStops" href="#gdipstringformatObject.setTabStops">&#x23;</a>
设置此 StringFormat 对象中制表位的偏移量，  
也就是 `\t` 字符输出的跨度。  
参数 @tabStops 应当指定数值数组，指定空值或空数组忽略不执行任何操作。  
可选用参数 @offset 指定起始偏移量（默认为 0）

### gdipstringformatObject.tabStops <a id="gdipstringformatObject.tabStops" href="#gdipstringformatObject.tabStops">&#x23;</a>
指定或获取制表位的偏移量数组

### gdipstringformatObject.trimming <a id="gdipstringformatObject.trimming" href="#gdipstringformatObject.trimming">&#x23;</a>

```aardio
gdipstringformatObject.trimming = _GdipStringTrimming/*剪裁样式，确定如何剪裁字符串使其适合布局矩形*/  ;
```

### 自动完成常量
_gdipStringDigitSubstituteNational=2  
_gdipStringDigitSubstituteNone=1  
_gdipStringDigitSubstituteTraditional=3  
_gdipStringDigitSubstituteUser=0  
