Click or drag to resize

TextOverlayProperties Class

Text Overlay Properties Class

This class will trigger OverlayPropertiesChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DM.Streaming.OverlayOverlayProperties
    Crestron.SimplSharpPro.DM.Streaming.OverlayTextOverlayProperties

Namespace: Crestron.SimplSharpPro.DM.Streaming.Overlay
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public class TextOverlayProperties : OverlayProperties

The TextOverlayProperties type exposes the following members.

Properties
 NameDescription
Public propertyBackgroundColor 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.
Public propertyBackgroundColorCustom 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.
Public propertyBackgroundColorCustomFeedback 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.

Public propertyBackgroundColorFeedback 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.

Public propertyBackgroundColorStandard Property to set the Text overlay background color standard type. This property is supported by HD-WP-4K-401-C device only.
Public propertyBackgroundColorStandardFeedback 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.

Public propertyBackgroundTransparency 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.
Public propertyBackgroundTransparencyFeedback 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.

Public propertyDisableFeedback Property to report the text/image overlay disabled status.

The OverlayPropertiesChange event will trigger with DisabledEventId.


(Inherited from OverlayProperties)
Public propertyDropShadowDisableFeedback 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.
Public propertyDropShadowEnableFeedback 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.
Public propertyEnableFeedback Property to report the text/image overlay enabled status.

The OverlayPropertiesChange event will trigger with EnabledEventId.


(Inherited from OverlayProperties)
Public propertyFontColor 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.
Public propertyFontColorCustom 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.
Public propertyFontColorCustomFeedback 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.

Public propertyFontColorFeedback 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.

Public propertyFontColorStandard Property to set the Text overlay font color standard type. This property is supported by HD-WP-4K-401-C device only.
Public propertyFontColorStandardFeedback 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.

Public propertyFontColorTransparency 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.
Public propertyFontColorTransparencyFeedback 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.

Public propertyFontDecoration Property to select the bitmask corresponding to a font decoration.
Public propertyFontDecorationFeedback Property to report the selected font decoration.

The OverlayPropertiesChange event will trigger with FontDecorationFeedbackEventId.

Public propertyFontFace 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.
Public propertyFontFaceFeedback 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.
Public propertyFontSize Property to set the size of the font in pixels.
Public propertyFontSizeFeedback 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.

Public propertyLocation Property to set the location of the overlayed text/image.
(Inherited from OverlayProperties)
Public propertyLocationFeedback Property to report the location of the overlayed text/image.

The OverlayPropertiesChange event will trigger with LocationFeedbackEventId.


(Inherited from OverlayProperties)
Public propertyOwner This represents the owner of this class and needs to be cast accordingly.
(Inherited from OverlayProperties)
Public propertyScrollDisableFeedback 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.
Public propertyScrollEnableFeedback 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.
Public propertyScrollRate 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.
Public propertyScrollRateFeedback 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.
Public propertyText Property to set the text to be displayed on the screen.
Public propertyTextFeedback Property to return the text to be displayed on the screen.

The OverlayPropertiesChange event will trigger with TextFeedbackEventId.

Public propertyTransparency 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)
Public propertyTransparencyFeedback 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)
Public propertyType Type of Overlay Properties class.
(Inherited from OverlayProperties)
Public propertyXPosition Property to set the X position of the text/image overlay (in pixels) based on the value set in Location.
(Inherited from OverlayProperties)
Public propertyXPositionFeedback Property to report the X position of the text/image overlay (in pixels).

The OverlayPropertiesChange event will trigger with XPositionFeedbackEventId.


(Inherited from OverlayProperties)
Public propertyYPosition Property to set the Y the position of the text/image overlay (in lines) based on the value set in Location.
(Inherited from OverlayProperties)
Public propertyYPositionFeedback Property to report the Y position of the text/image overlay (in pixels).

The OverlayPropertiesChange event will trigger with YPositionFeedbackEventId.


(Inherited from OverlayProperties)
Top
Methods
 NameDescription
Public methodDisable Method to disable text/image overlay.
(Inherited from OverlayProperties)
Public methodDropShadowDisable 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.
Public methodDropShadowEnable Method to apply the drop shadow effect to the text. This method is not supported by DMF-XX-4K-SFP device.
Public methodEnable Method to enable text/image overlay.
(Inherited from OverlayProperties)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodScrollDisable 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.
Public methodScrollEnable 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.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventOverlayPropertiesChange Event triggered when TextOverlayProperties or ImageOverlayProperties sig change is received from the device.
(Inherited from OverlayProperties)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also