stdole_Font
Namespace: PPJ.Runtime.Com
Assembly: PPJ.Web.50 (5.0.0.0)
Wraps the standard OLE font automation interface using SAL values.
- C#
- VB.NET
public class stdole_Font : SalObject
Public Class stdole_Font
Inherits SalObject
Attach an appropriate COM object before accessing interface properties.
Example:
using PPJ.Runtime.Com;
using (var value = new stdole_StdFont())
{
if (value.Create())
System.Console.WriteLine(value.IsDispatchValid());
}
Constructors
stdole_Font()
Initializes a new instance of stdole_Font.
Fields
| Name | Type | Description | Value |
|---|---|---|---|
| _Interface | COMInterface | The typed OLE automation interface attached to this wrapper. |
Methods
PropGetBold(returnValue)
Reads the bold formatting flag from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
returnValue  | SalBoolean | Receives the bold formatting flag. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetCharset(returnValue)
Reads the character-set identifier from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalNumber | Receives the character-set identifier. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetItalic(returnValue)
Reads the italic formatting flag from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalBoolean | Receives the italic formatting flag. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetName(returnValue)
Reads the font family name from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalString | Receives the font family name. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetSize(returnValue)
Reads the font size in points from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalNumber | Receives the font size in points. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetStrikethrough(returnValue)
Reads the strikethrough formatting flag from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalBoolean | Receives the strikethrough formatting flag. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetUnderline(returnValue)
Reads the underline formatting flag from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalBoolean | Receives the underline formatting flag. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropGetWeight(returnValue)
Reads the font weight from the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| returnValue | SalNumber | Receives the font weight. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetBold(Bold)
Assigns the bold formatting flag on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Bold | SalBoolean | The bold formatting flag to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetCharset(Charset)
Assigns the character-set identifier on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Charset | SalNumber | The character-set identifier to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetItalic(Italic)
Assigns the italic formatting flag on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Italic | SalBoolean | The italic formatting flag to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetName(Name)
Assigns the font family name on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Name | SalString | The font family name to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetSize(Size)
Assigns the font size in points on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Size | SalNumber | The font size in points to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetStrikethrough(Strikethrough)
Assigns the strikethrough formatting flag on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Strikethrough | SalBoolean | The strikethrough formatting flag to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetUnderline(Underline)
Assigns the underline formatting flag on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Underline | SalBoolean | The underline formatting flag to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
PropSetWeight(Weight)
Assigns the font weight on the attached OLE interface.
| Parameter | Type | Description |
|---|---|---|
| Weight | SalNumber | The font weight to assign. |
Returns: SalBoolean. True on success; false when a COM error is recorded with AutoErrorMode disabled.
Inherited By
| Name | Description |
|---|---|
| stdole_StdFont | Wraps the standard OLE font coclass for activation and SAL-compatible access. |