Text |
This class will trigger OverlayPropertiesChange event.
public class TextOverlayProperties : OverlayProperties
The TextOverlayProperties type exposes the following members.
| Name | Description | |
|---|---|---|
| BackgroundColor | Property to set the background color. Takes hex triplet (#1122CC), shorthand (#ccc) or HTML color name. Case insensitive. This sig is supported only by HD-WP-4K-401-C device. | |
| BackgroundColorCustom | Property to set the hex triplet (#1122CC) for custom background color. Case insensitive. This property is supported by HD-WP-4K-401-C device only. | |
| BackgroundColorCustomFeedback |
Property to return the current hex triplet (#1122CC) for custom background color. Case insensitive.
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with BackgroundColorCustomFeedbackEventId. | |
| BackgroundColorFeedback |
Property to report the current background color.
This sig is supported only by HD-WP-4K-401-C device.
The OverlayPropertiesChange event will trigger with BackgroundColorFeedbackEventId. | |
| BackgroundColorStandard | Property to set the Text overlay background color standard type. This property is supported by HD-WP-4K-401-C device only. | |
| BackgroundColorStandardFeedback |
Property to report the Text overlay background color standard type.
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with BackgroundColorStandardFeedbackEventId. | |
| BackgroundTransparency | Property to set the Text overlay background transparency. Range: Minimum: 0, Maximum: 100, Resolution: 1 This property is supported by HD-WP-4K-401-C device only. | |
| BackgroundTransparencyFeedback |
Property to report the Text overlay background transparency.
Range: Minimum: 0, Maximum: 100, Resolution: 1
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with BackgroundTransparencyFeedbackEventId. | |
| DisableFeedback |
Property to report the text/image overlay disabled status.
The OverlayPropertiesChange event will trigger with DisabledEventId. (Inherited from OverlayProperties) | |
| DropShadowDisableFeedback |
Property to indicate that the drop shadow effect for text is not applied.
The OverlayPropertiesChange event will trigger with DropShadowDisabledEventId. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| DropShadowEnableFeedback |
Property to indicate that the drop shadow effect for text is applied.
The OverlayPropertiesChange event will trigger with DropShadowEnabledEventId. This property is not supported by DMF-XX-4K-SFP device. | |
| EnableFeedback |
Property to report the text/image overlay enabled status.
The OverlayPropertiesChange event will trigger with EnabledEventId. (Inherited from OverlayProperties) | |
| FontColor | Property to set the font color. Takes hex triplet (#1122CC), shorthand (#ccc) or HTML color name. Case insensitive. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| FontColorCustom | Property to set the hex triplet (#1122CC) for custom font color. Case insensitive. This property is supported by HD-WP-4K-401-C device only. | |
| FontColorCustomFeedback |
Property to return the current hex triplet (#1122CC) for custom font color. Case insensitive.
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with FontColorCustomFeedbackEventId. | |
| FontColorFeedback |
Property to report the current font color.
This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices.
The OverlayPropertiesChange event will trigger with FontColorFeedbackEventId. | |
| FontColorStandard | Property to set the Text overlay font color standard type. This property is supported by HD-WP-4K-401-C device only. | |
| FontColorStandardFeedback |
Property to report the current Text overlay font color standard type.
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with FontColorStandardFeedbackEventId. | |
| FontColorTransparency | Property to set the Text overlay font transparency. Range: Minimum: 0, Maximum: 100, Resolution: 1 This property is supported by HD-WP-4K-401-C device only. | |
| FontColorTransparencyFeedback |
Property to report the current Text overlay font transparency.
Range: Minimum: 0, Maximum: 100, Resolution: 1
This property is supported by HD-WP-4K-401-C device only.
The OverlayPropertiesChange event will trigger with FontColorTransparencyFeedbackEventId. | |
| FontDecoration | Property to select the bitmask corresponding to a font decoration. | |
| FontDecorationFeedback |
Property to report the selected font decoration.
The OverlayPropertiesChange event will trigger with FontDecorationFeedbackEventId. | |
| FontFace | Property to select a font from a built in list. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| FontFaceFeedback |
Property to report the selected font face.
The OverlayPropertiesChange event will trigger with FontFaceFeedbackEventId. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| FontSize | Property to set the size of the font in pixels. | |
| FontSizeFeedback |
Property to report the current font size in pixels.
This sig is not supported by DMF-XX-4K-SFP device.
The OverlayPropertiesChange event will trigger with FontSizeFeedbackEventId. | |
| Location |
Property to set the location of the overlayed text/image.
(Inherited from OverlayProperties) | |
| LocationFeedback |
Property to report the location of the overlayed text/image.
The OverlayPropertiesChange event will trigger with LocationFeedbackEventId. (Inherited from OverlayProperties) | |
| Owner |
This represents the owner of this class and needs to be cast accordingly.
(Inherited from OverlayProperties) | |
| ScrollDisableFeedback |
Property to indicate the text scrolling disabled status.
The OverlayPropertiesChange event will trigger with ScrollDisabledEventId. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| ScrollEnableFeedback |
Property to indicate the text scrolling enabled status.
The OverlayPropertiesChange event will trigger with ScrollEnabledEventId. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| ScrollRate | Property to set the rate to scroll the text in characters per second. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| ScrollRateFeedback |
Property to report the scroll rate of the text in characters per second.
The OverlayPropertiesChange event will trigger with ScrollRateFeedbackEventId. This property is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| Text | Property to set the text to be displayed on the screen. | |
| TextFeedback |
Property to return the text to be displayed on the screen.
The OverlayPropertiesChange event will trigger with TextFeedbackEventId. | |
| Transparency |
Property to set the transparency of the text/image for DmRmc100Str and HdWp4k401C or DmfXx4kSfp.
Property to set the transparency of the text and the background for "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C".
Setting this property sets the "BackgroundTransparency" property of the "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C".
Use PercentToUshort(Single) to convert
the percentage to a ushort value or UshortToPercent(UInt16) to convert
the ushort value to percentage.
(Inherited from OverlayProperties) | |
| TransparencyFeedback |
Property to report the current transparency value of the text/image DmRmc100Str and HdWp4k401C.
Property to report the current transparency value of the text and the background for "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C".
Reading this property returns the "BackgroundTransparencyFeedback" property of the "DmNvx350", "DmNvx351", "DmNvx350C" or "DmNvx351C".
Use PercentToUshort(Single) to convert
the percentage to a ushort value or UshortToPercent(UInt16) to convert
the ushort value to percentage.
The OverlayPropertiesChange event will trigger with TransparencyFeedbackEventId. (Inherited from OverlayProperties) | |
| Type |
Type of Overlay Properties class.
(Inherited from OverlayProperties) | |
| XPosition |
Property to set the X position of the text/image overlay (in pixels) based on the value set in Location.
(Inherited from OverlayProperties) | |
| XPositionFeedback |
Property to report the X position of the text/image overlay (in pixels).
The OverlayPropertiesChange event will trigger with XPositionFeedbackEventId. (Inherited from OverlayProperties) | |
| YPosition |
Property to set the Y the position of the text/image overlay (in lines) based on the value set in Location.
(Inherited from OverlayProperties) | |
| YPositionFeedback |
Property to report the Y position of the text/image overlay (in pixels).
The OverlayPropertiesChange event will trigger with YPositionFeedbackEventId. (Inherited from OverlayProperties) |
| Name | Description | |
|---|---|---|
| Disable |
Method to disable text/image overlay.
(Inherited from OverlayProperties) | |
| DropShadowDisable | Method to disable the drop shadow effect applied to the text. This method is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| DropShadowEnable | Method to apply the drop shadow effect to the text. This method is not supported by DMF-XX-4K-SFP device. | |
| Enable |
Method to enable text/image overlay.
(Inherited from OverlayProperties) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| ScrollDisable | Method to disable the text scrolling, the text scrolling will be stopped until ScrollEnable is called later. This method is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| ScrollEnable | Method to enable text scrolling, the text specified in the Text shall be smoothly scrolled from left to right at the rate specified in ScrollRate. The text shall scroll until no text is visible, then wait one-second and then begin scrolling again. This method is not supported by DMF-XX-4K-SFP and HD-WP-4K-401-C devices. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Name | Description | |
|---|---|---|
| OverlayPropertiesChange |
Event triggered when TextOverlayProperties or ImageOverlayProperties sig change is received from the device.
(Inherited from OverlayProperties) |