Monkeybread Xojo plugin - NSTextBlockMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

NSTextBlockMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Cocoa Text	MBS MacBase Plugin	22.0	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Function: A block of text laid out in a subregion of the text container.
Notes: A text block appears as an attribute of a paragraph, and as part of the paragraph style. The most important subclass of NSTextBlockMBS is NSTextTableBlockMBS, which represents a block of text that appears as a cell in a table. The table itself is a NSTextTable object. All NSTextBlockMBS objects reference this table, which controls their sizing and positioning.

5 properties
- property backgroundColor as NSColorMBS
- property contentWidth as Double
- property contentWidthValueType as Integer
- property Handle as Integer
- property verticalAlignment as Integer
13 methods
- method borderColor(edge as Integer) as NSColorMBS
- method Constructor
- method copy as NSTextBlockMBS
- method setBorderColor(color as NSColorMBS)
- method setBorderColor(color as NSColorMBS, edge as Integer)
- method setContentWidth(value as double, ValueType as Integer)
- method setValue(value as double, ValueType as Integer, dimension as Integer)
- method setWidth(value as double, ValueType as Integer, Layer as Integer)
- method setWidth(value as double, ValueType as Integer, Layer as Integer, edge as Integer)
- method valueForDimension(dimension as Integer) as Double
- method valueTypeForDimension(dimension as Integer) as Integer
- method width(layer as Integer, edge as Integer) as double
- method widthValueType(layer as Integer, edge as Integer) as Integer
15 constants

Dimension

Constant	Value	Description
DimensionHeight	4	Height of the text block.
DimensionMaximumHeight	6	Maximum height of the text block.
DimensionMaximumWidth	2	Maximum width of the text block.
DimensionMinimumHeight	5	Minimum height of the text block.
DimensionMinimumWidth	1	Minimum width of the text block.
DimensionWidth	0	Width of the text block.

Layer

Constant	Value	Description
LayerBorder	0	The border of the text block.
LayerMargin	1	Margin of the text block: space surrounding the border.
LayerPadding	-1	Padding of the text block: space surrounding the content area extending to the border.

Value Types

Constant	Value	Description
ValueTypeAbsolute	0	Absolute value in points.
ValueTypePercentage	1	Percentage value (out of 100).

Vertical Alignment

Constant	Value	Description
VerticalAlignmentBaseline	3	Aligns adjacent blocks at the baseline of the first line of text in the block.
VerticalAlignmentBottom	2	Aligns adjacent blocks at their bottom.
VerticalAlignmentMiddle	1	Aligns adjacent blocks at their middle.
VerticalAlignmentTop	0	Aligns adjacent blocks at their top.

Sub classes:

Some methods using this class:

NSAttributedStringMBS.rangeOfTextBlock(textBlock as NSTextBlockMBS, location as Integer) as NSRangeMBS
NSMutableParagraphStyleMBS.setTextBlocks(TextBlocks() as NSTextBlockMBS)
NSParagraphStyleMBS.textBlocks as NSTextBlockMBS()

Blog Entries

Xojo Developer Magazine

20.2, page 10: News

The items on this page are in the following plugins: MBS MacBase Plugin.

NSTextAttachmentMBS - NSTextCheckingResultMBS

💬 Ask a question or report a problem