Aspose.Note FOSS for Python

このリファレンスは、完全なパブリック API の全体像をカバーしています aspose-note バージョン 26.3.1。エクスポートされたシンボルのみが aspose.note パッケージはここで文書化されています。以下のものは aspose.note._internal 実装の詳細であり、予告なく変更される可能性があります。.

ImageRenderOptions: pip install aspose-note (core) または pip install "aspose-note[pdf]" (PDF エクスポート付き)

ImageRenderOptions: from aspose.note import Document, RichText, ...

ImageRenderOptions

ドキュメントとトラバーサル

ImageRenderOptionsImageRenderOptions
Documentルートドキュメントオブジェクト。ロードする .one ファイル、ページを反復し、PDF に保存します。.
DocumentVisitorドキュメントツリーのビジターパターン走査のための抽象基底クラス。.
Nodeすべてのドキュメントノードの基底クラス。.
CompositeNode子ノードを含むことができるノードの基底クラス。.

ドキュメント構造

ImageRenderOptionsImageRenderOptions
PageOneNote ページを表します。.
TitleTitleText、TitleDate、TitleTime を含むページタイトルブロック。.
OutlineOutlineElement ノード用の位置コンテナ。.
OutlineElementリーフコンテナ；RichText、Image、Table、AttachedFile を保持します。.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
RichText書式ラン、タグ、ハイパーリンクを含むテキストブロック。.
TextRunRichText 内の単一の書式付きテキストセグメント。.
TextStyleTextRun の書式プロパティ。.
Image生バイトとメタデータを含む埋め込み画像。.
AttachedFile生バイトを含む埋め込みファイル添付。.
Table行、セル、列幅を持つテーブル。.
TableRowテーブル内の行。.
TableCellTableRow 内のセルです。コンテンツノードを含みます。.
NoteTagコンテンツノードに付随する OneNote タグ（星、チェックボックスなど）。.
NumberListOutlineElement 上の番号付きリストメタデータ。.

ImageRenderOptions

ImageRenderOptionsImageRenderOptions
LoadOptions読み込みオプション .one ファイル。.
SaveOptions保存オプションの基底クラス。.
PdfSaveOptionsPDF 固有の保存オプション（タグアイコン）。.

互換性スタブ

ImageRenderOptionsImageRenderOptions
License互換性スタブ：: SetLicense() この FOSS 実装では何もしません。.
Metered互換性スタブ：: SetMeteredKey() この FOSS 実装では何もしません。.

クラスの詳細

ImageRenderOptions

ルートドキュメントクラスです。ロードする .one ファイルパスからファイル、あるいは pathlib.Path,、またはバイナリストリームです。.

from aspose.note import Document, LoadOptions

doc = Document(source=None, load_options=None)

コンストラクタ パラメータ:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
source`strPath
load_options`LoadOptionsNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
DisplayName`strNone`
CreationTime`datetimeNone`
FileFormatFileFormatOneNote ファイル形式バージョンのベストエフォートな指標

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Count()() -> int直接の子ページ数
GetPageHistory(page)(Page) -> list[Page]ImageRenderOptions [page] (スタブ; 完全な履歴はまだ実装されていません)
DetectLayoutChanges()() -> None互換性スタブ; 操作なし
Save(target, format_or_options)`(strPath
Accept(visitor)(DocumentVisitor) -> Noneビジタートラバーサルを呼び出す
for page in docN/A直接の子を反復処理する Page ノード

Document.FileFormat 注:：このプロパティは OneNote ファイル形式バージョンのベストエフォートな指標を提供します。The FileFormat 列挙型には3つの値があります：: OneNote2010, OneNoteOnline,、そして OneNote2007.

Document.Save() ストリームサポート: target はバイナリストリームになり得ます（io.BytesIO,、バイナリ書き込みモードで開かれたファイルハンドルなど）。テストスイートで確認されています：: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).

DocumentVisitor

ビジターパターンのトラバーサル用抽象基底クラスです。必要な visit メソッドをオーバーライドしてください:

ImageRenderOptions呼び出されるのは
VisitDocumentStart(doc)Documentノードに入る
VisitDocumentEnd(doc)Documentノードを離れる
VisitPageStart(page)Pageノードに入る
VisitPageEnd(page)Pageノードを離れる
VisitTitleStart(title)Titleノードに入る
VisitTitleEnd(title)Titleノードを離れる
VisitOutlineStart(outline)Outline ノードに入ります
VisitOutlineEnd(outline)Outline ノードを離れます
VisitOutlineElementStart(oe)OutlineElement ノードに入ります
VisitOutlineElementEnd(oe)OutlineElement ノードを離れます
VisitRichTextStart(rt)RichText ノードに入ります
VisitRichTextEnd(rt)RichText ノードを離れます
VisitImageStart(img)Image ノードに入ります
VisitImageEnd(img)Image ノードを離れます

ImageRenderOptions

すべてのドキュメントツリーノードの基底クラスです。.

プロパティ / メソッドImageRenderOptionsImageRenderOptions
ParentNode`NodeNone`
Document`DocumentNone`
Accept(visitor)(DocumentVisitor) -> Noneこのノードに visitor をディスパッチする

CompositeNode

ImageRenderOptions Node.。子管理を追加します:

プロパティ / メソッドImageRenderOptions
FirstChild最初の子ノード、または None
LastChild最後の子ノード、または None
AppendChildLast(node)末尾に子ノードを追加します; 設定します node.ParentNode = self
AppendChildFirst(node)先頭に子ノードを追加します
InsertChild(index, node)指定された位置に子ノードを挿入します
RemoveChild(node)子ノードを削除します; 設定します node.ParentNode = None
GetEnumerator()直接の子要素に対するイテレータを返します
for child in node直接の子要素を反復処理する
GetChildNodes(Type)(Type) -> list[Type]: 再帰的に、サブツリー全体を深さ優先で検索し、含む self

ImageRenderOptions

ImageRenderOptions CompositeNode. OneNote ページを表します。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Clone(deep=False)ページの浅いクローンまたは深いクローンを返す

ImageRenderOptions

ImageRenderOptions CompositeNode. タイトルブロックを保持する Page.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
TitleText`RichTextNone`
TitleDate`RichTextNone`
TitleTime`RichTextNone`

ImageRenderOptions

ImageRenderOptions CompositeNode. 位置コンテナ OutlineElement ノード。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
X`floatNone`
Y`floatNone`
Width`floatNone`

OutlineElement

ImageRenderOptions CompositeNode. コンテンツノードを保持するリーフコンテナ。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
IndentLevelint入れ子の深さ（0 = 最外層）
NumberList`NumberListNone`
Tagslist[NoteTag]この要素に添付された OneNote タグ

RichText

ImageRenderOptions CompositeNode. スタイルが適用されたテキストのブロック。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Textstrすべてのランを連結したフルプレーンテキスト文字列
Runslist[TextRun]フォーマットされたセグメントの順序付きリスト
FontSize`floatNone`
Tagslist[NoteTag]このブロックに添付された OneNote タグ

ImageRenderOptions:

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Append(text, style=None)`(str, TextStyleNone) -> RichText`
Replace(old_value, new_value)(str, str) -> Noneメモリ内文字列置換 on Text; 更新されません Runs

TextRun

ImageRenderOptions Node. 単一の書式設定されたテキストセグメント。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
Textstrセグメントのテキスト内容（デフォルト "")
StyleTextStyle書式設定プロパティ
Start`intNone`
End`intNone`

TextStyle

ImageRenderOptions Node. 文字単位の書式設定プロパティ（対象は TextRun.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
BoldboolFalseImageRenderOptions
ItalicboolFalseImageRenderOptions
UnderlineboolFalseImageRenderOptions
StrikethroughboolFalseImageRenderOptions
SuperscriptboolFalseImageRenderOptions
SubscriptboolFalseImageRenderOptions
FontName`strNone`None
FontSize`floatNone`None
FontColor`intNone`None
HighlightColor`intNone`None
LanguageId`intNone`None
IsHyperlinkboolFalseこの実行がハイパーリンクかどうか
HyperlinkAddress`strNone`None

ImageRenderOptions

ImageRenderOptions CompositeNode.埋め込み画像です。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
Bytesbytes生画像データ (デフォルト b"")
Width`floatNone`
Height`floatNone`
AlternativeTextTitle`strNone`
AlternativeTextDescription`strNone`
HyperlinkUrl`strNone`
Tagslist[NoteTag]この画像に付けられた OneNote タグ

ImageRenderOptions:

ImageRenderOptionsImageRenderOptions
Replace(image)ImageRenderOptions Bytes および FileName 別の Image ノードをこのノードに

AttachedFile

ImageRenderOptions CompositeNode. 埋め込みファイル添付。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
FileName`strNone`
Bytesbytes生のファイルデータ（デフォルト b"")
Tagslist[NoteTag]この添付ファイルに付けられた OneNote タグ

ImageRenderOptions

ImageRenderOptions CompositeNode. OutlineElement 内のテーブル。.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Columnslist[float][]各列の幅（ポイント）
IsBordersVisibleboolTrueテーブルの枠線が表示されているかどうか
Tagslist[NoteTag][]このテーブルに付けられた OneNote タグ

TableRow

ImageRenderOptions CompositeNode. a の中の行 Table. 繰り返す GetChildNodes(TableCell) セルにアクセスするために。.

TableCell

ImageRenderOptions CompositeNode. a の中のセル TableRow. 含む RichText, Image, および他のコンテンツノード。.

NoteTag

ImageRenderOptions Node. コンテンツノードに付けられた OneNote タグ。.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
shape`intNone`None
label`strNone`None
text_color`intNone`None
highlight_color`intNone`None
created`intNone`None
completed`intNone`None

タイムスタンプの注釈: created および completed は MS-ONE バイナリ形式から解析された生の整数タイムスタンプであり、 datetime オブジェクトではありません。.

ファクトリーメソッド:

ImageRenderOptionsImageRenderOptions
NoteTag.CreateYellowStar()作成します a NoteTag(shape=None, label="Yellow Star")

NumberList

ImageRenderOptions Node. 番号付きまたは箇条書きリストのメタデータが OutlineElement.

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
Format`strNone`None
Restart`intNone`None
IsNumberedboolFalse順序付き（番号付き）リストの場合は true

LoadOptions

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
DocumentPassword`strNone`None
LoadHistoryboolFalseAPI 互換性フィールド; v26.3.1 では機能的に使用されていません

SaveOptions

すべての保存オプションの基底クラスです。必須の位置引数です。.

ImageRenderOptionsImageRenderOptionsImageRenderOptions
SaveFormatSaveFormat対象の保存形式

PdfSaveOptions

ImageRenderOptions SaveOptions. PDF 固有のエクスポート設定。次で構築 PdfSaveOptions(SaveFormat.Pdf).

ImageRenderOptionsImageRenderOptionsImageRenderOptionsImageRenderOptions
PageIndexint0フィールドが存在します; v26.3.1 では PDF エクスポーターに転送されません: 出力に影響しません
PageCount`intNone`None
TagIconDir`strNone`None
TagIconSize`floatNone`None
TagIconGap`floatNone`None

PageIndex / PageCount 注意点: これらのフィールドは宣言されています PdfSaveOptions API 互換性のために宣言されていますが、 Document.Save() v26.3.1 の実装では、これらを PDF エクスポーターに読み取ったり転送したりしません。すべてのページは常にエクスポートされます。.

ライセンスと従量課金

.NET 用の Aspose.Note と API 形状互換性を保つために互換性スタブがエクスポートされています。この FOSS 実装ではすべてのメソッドは何もしません。.

from aspose.note import License, Metered

lic = License()
lic.SetLicense("path/to/license.lic")  # no-op

m = Metered()
m.SetMeteredKey("public_key", "private_key")  # no-op

Python 用の Aspose.Note FOSS の機能を使用する際にライセンスキーは不要です。.

ImageRenderOptions

完全な列挙参照: ImageRenderOptions

SaveFormat

ImageRenderOptionsImageRenderOptions
SaveFormat.PdfPDF エクスポート: 実装済み; 必要なのは pip install "aspose-note[pdf]"
SaveFormat.OneOneNote フォーマット: 宣言のみ; 発生するのは UnsupportedSaveFormatException

FileFormat

OneNote ファイルフォーマットバージョンを表す列挙値。. Document.FileFormat 最善の努力での指標を提供します。.

ImageRenderOptions文字列値
FileFormat.OneNote2010"onenote2010"
FileFormat.OneNoteOnline"onenoteonline"
FileFormat.OneNote2007"onenote2007"

HorizontalAlignment

ImageRenderOptions文字列値
HorizontalAlignment.Left"left"
HorizontalAlignment.Center"center"
HorizontalAlignment.Right"right"

NodeType

ImageRenderOptions文字列値
NodeType.Document"document"
NodeType.Page"page"
NodeType.Outline"outline"
NodeType.OutlineElement"outline_element"
NodeType.RichText"rich_text"
NodeType.Image"image"
NodeType.Table"table"
NodeType.AttachedFile"attached_file"

ImageRenderOptions

完全な例外リファレンス：: ImageRenderOptions

ImageRenderOptionsImageRenderOptions
AsposeNoteErrorすべての Aspose.Note FOSS 例外の基底クラス
FileCorruptedExceptionImageRenderOptions .one ファイルを解析できません（破損または不正なバイナリ）
IncorrectDocumentStructureExceptionファイル構造が無効またはサポートされていません
IncorrectPasswordException次の場合に発生します LoadOptions.DocumentPassword が設定されています；暗号化されたドキュメントはサポートされていません
UnsupportedFileFormatExceptionファイル形式が認識されません；次のものを公開します FileFormat フィールド（文字列）
UnsupportedSaveFormatException要求された SaveFormat はこのバージョンでは実装されていません

関連項目

 日本語