NSAttributedStringMBS.Constructor

NSAttributedStringMBS.Convert_Operator as string

NSAttributedStringMBS.copy as NSAttributedStringMBS

NSAttributedStringMBS.CopyToClipboard as Boolean

NSAttributedStringMBS.dataFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil, byref error as NSErrorMBS) as memoryblock

offset and length: The range.
documentAttributes: A required dictionary specifying the document attributes. The dictionary contains values from Document Types and must at least contain NSDocumentTypeDocumentAttribute.
error: An in-out variable containing an encountered error, if any.

Returns the data for the attributed string, or nil if failure. When nil, error encapsulates the error information.
Raises an NSRangeException if any part of range lies beyond the end of the receiver’s characters.

NSAttributedStringMBS.docFormatFromRange(documentAttributes as dictionary = nil) as MemoryBlock

Same as docFormatFromRange(0,length)
Returns nil on failure.
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• docFormatFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

Some examples using this method:

• /MacControls/TextView advanced

NSAttributedStringMBS.docFormatFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

Returns nil on failure.
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• docFormatFromRange(documentAttributes as dictionary = nil) as MemoryBlock

NSAttributedStringMBS.fileWrapperFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil, byref Error as NSErrorMBS) as NSFileWrapperMBS

// get styled text from htmlviewer
Var w as WebViewMBS = HTMLViewer1.WebViewMBS
Var f as WebFrameMBS = w.mainFrame
Var v as WebFrameViewMBS = f.frameView
Var d as WebDocumentViewMBS = v.documentView
Var n as NSAttributedStringMBS = d.attributedString


// package it
Var da as new Dictionary
da.Value(n.NSDocumentTypeDocumentAttribute) = n.NSRTFDTextDocumentType

Var e as NSErrorMBS
Var fw as NSFileWrapperMBS = n.fileWrapperFromRange(0, n.Length, da, e)
if e <> nil then
  MsgBox e.LocalizedDescription
  Return
end if

// write to disk
Var file as FolderItem = SpecialFolder.Desktop.Child("test.rtfd")
if fw.writeToFile(file, e) then
  MsgBox "OK"
else
  MsgBox e.LocalizedDescription
end if

offset and length: The range.
documentAttributes: A required dictionary specifying the document attributes. The dictionary contains values from Document Types and must at least contain NSDocumentTypeDocumentAttribute.
error: An in-out variable containing an encountered error, if any.

Returns a file wrapper for the appropriate document type, or nil if failure. When nil, error encapsulates the error information.

Raises an NSRangeException if any part of range lies beyond the end of the receiver’s characters.

NSAttributedStringMBS.GeneratePDF(PrintOptions as Variant = nil) as MemoryBlock

// read file
Var fi as FolderItem = SpecialFolder.Desktop.Child("test.docx")

Var d as new Dictionary
Var n as NSAttributedStringMBS = NSAttributedStringMBS.attributedStringWithPath(fi, d)

// write pdf
Var p as MemoryBlock = n.GeneratePDF(nil)

Var fo as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
Var bo as BinaryStream = BinaryStream.Create(fo)
bo.Write p

PrintOptions is optional NSPrintInfoMBS object for print settings like margin.

NSAttributedStringMBS.htmlString as string

Var s as NSAttributedStringMBS

s=new NSAttributedStringMBS

if s.initwithhtml("<b>Hello</b>") then
  MsgBox s.htmlstring // shows "<b>Hello</b>"
  MsgBox s.text // shows "Hello"
end if

Does not always work well, but can help.
(Apple has no official function for this)

Some examples using this method:

• /MacControls/TextView advanced
• /Util/BugreporterKit/BugReporter

NSAttributedStringMBS.lineRangeForRange(range as NSRangeMBS) as NSRangeMBS

Range: A range within the receiver. The value must not exceed the bounds of the receiver.

The range of characters representing the line or lines containing aRange, including the line termination characters.

NSAttributedStringMBS.mutableCopy as NSMutableAttributedStringMBS

// create Hello World in red
Var a as NSAttributedStringMBS = NSAttributedStringMBS.attributedStringWithString("Hello World")
Var m as NSMutableAttributedStringMBS = a.mutableCopy

m.addAttribute(a.NSForegroundColorAttributeName, NSColorMBS.redColor, new NSRangeMBS(0, m.length))

// put it in a textarea
TextArea1.NSTextViewMBS.textStorage.setAttributedString m

NSAttributedStringMBS.paragraphRangeForRange(range as NSRangeMBS) as NSRangeMBS

Range: A range within the receiver. The range must not exceed the bounds of the receiver.

The range of characters representing the paragraph or paragraphs containing range, including the paragraph termination characters.

A paragraph is any segment of text delimited by a carriage return (U+000D), newline (U+000A), or paragraph separator (U+2029).

NSAttributedStringMBS.rangeOfTextBlock(textBlock as NSTextBlockMBS, location as Integer) as NSRangeMBS

NSAttributedStringMBS.rangeOfTextList(list as NSTextListMBS, location as Integer) as NSRangeMBS

list: The text list.
location: The location in the text list.

Returns the range of the given text list containing the location.

NSAttributedStringMBS.rangeOfTextTable(textTable as NSTextTableMBS, location as Integer) as NSRangeMBS

NSAttributedStringMBS.rtf as MemoryBlock

Var s as NSAttributedStringMBS

s=new NSAttributedStringMBS

if s.initWithString("Hello") then
  MsgBox s.RTF
end if

// shows this text:
// {\rtf1\ansi\ansicpg1252\cocoartf949
// {\fonttbl\f0\fswiss\fcharset0 Helvetica;}
// {\colortbl;\red255\green255\blue255;}
// \pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural\pardirnatural
//
// \f0\fs24 \cf0 Hello}

Same as RTFFromRange(0,length)

NSAttributedStringMBS.RTFDFileWrapperFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as NSFileWrapperMBS

offset and length: The range.
documentAttributes: A required dictionary specifying the document attributes. The dictionary contains values from Document Types and must at least contain NSDocumentTypeDocumentAttribute. If there are no document-level attributes, dict can be nil.

Returns a file wrapper containing the RTFD data.

The file wrapper also includes the document-level attributes in docAttributes, as explained in RTF Files and Attributed Strings.
Raises an NSRangeException if any part of aRange lies beyond the end of the receiver’s characters.
You can save the file wrapper using the NSFileWrapper method writeToFile.

NSAttributedStringMBS.RTFDFromRange(documentAttributes as dictionary = nil) as MemoryBlock

Returns nil on failure.
Same as RTFDFromRange(0,length)
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• RTFDFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

NSAttributedStringMBS.RTFDFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

Returns nil on failure.
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• RTFDFromRange(documentAttributes as dictionary = nil) as MemoryBlock

NSAttributedStringMBS.RTFFromRange(documentAttributes as dictionary = nil) as MemoryBlock

Returns nil on failure.
Same as RTFFromRange(0,length)
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• RTFFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

NSAttributedStringMBS.RTFFromRange(offset as Integer, length as Integer, documentAttributes as dictionary = nil) as MemoryBlock

// get some attributed text:
Var t as new NSAttributedStringMBS
call t.initWithString("Hello World")

// set document attributes
Var dic as new Dictionary
dic.Value(t.NSBottomMarginDocumentAttribute) = 20
dic.Value(t.NSLeftMarginDocumentAttribute) = 20
dic.Value(t.NSRightMarginDocumentAttribute) = 20
dic.Value(t.NSTopMarginDocumentAttribute) = 20
dic.Value(t.NSAuthorDocumentAttribute) = "Test User"

// get rtf
Var rtf as string = t.RTFFromRange(dic)

// write to file
Var f as FolderItem = SpecialFolder.Desktop.Child("test.rtf")
Var b as BinaryStream = BinaryStream.Create(f, true)
b.Write rtf

Returns nil on failure.
documentAttributes can optionally be a dictionary with document attributes like author or title.

See also:

• RTFFromRange(documentAttributes as dictionary = nil) as MemoryBlock